Charthop goalProgress API

The goalProgress API from Charthop — 2 operation(s) for goalprogress.

Operations 5

GET /v1/org/{orgId}/goal-progress Find goal progress for a goal #
POST /v1/org/{orgId}/goal-progress Create a new goal progress update #
GET /v1/org/{orgId}/goal-progress/{goalProgressId} Get a goal progress by id #
PATCH /v1/org/{orgId}/goal-progress/{goalProgressId} Update an existing goal progress #
DELETE /v1/org/{orgId}/goal-progress/{goalProgressId} Delete a goal progress #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/charthop-goalprogress-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

charthop-goalprogress-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Goal Progress API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: goalProgress
paths:
  /v1/org/{orgId}/goal-progress:
    get:
      tags:
      - goalProgress
      summary: Find goal progress for a goal
      operationId: findGoalProgress
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: goalId
        in: query
        description: Goal id
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      - name: returnAccess
        in: query
        description: 'Return access information -- pass a list of actions to check, for example: create,update,delete'
        required: false
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsGoalProgress'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - goalProgress
      summary: Create a new goal progress update
      operationId: createGoalProgress
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalProgress'
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: goal not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGoalProgress'
        description: Goal progress data to create
        required: true
  /v1/org/{orgId}/goal-progress/{goalProgressId}:
    get:
      tags:
      - goalProgress
      summary: Get a goal progress by id
      operationId: getGoalProgress
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: goalId
        in: path
        description: Goal id
        required: true
        schema:
          type: string
      - name: goalProgressId
        in: path
        description: Goal progress id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalProgress'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    patch:
      tags:
      - goalProgress
      summary: Update an existing goal progress
      operationId: updateGoalProgress
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: goalProgressId
        in: path
        description: Goal progress id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalProgress'
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGoalProgress'
        description: Goal progress data to update
        required: true
    delete:
      tags:
      - goalProgress
      summary: Delete a goal progress
      operationId: deleteGoalProgress
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: goalProgressId
        in: path
        description: Goal progress id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: deleted
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
components:
  schemas:
    Attribution:
      type: object
      properties:
        principalUserId:
          type: string
          example: 588f7ee98f138b19220041a7
        agentUserIds:
          type: array
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        eventId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiChatId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiToolUseId:
          type: string
        channel:
          type: string
          enum:
          - WEB
          - MOBILE
          - SLACK
          - TEAMS
          - MCP
    GoalProgress:
      type: object
      required:
      - id
      - orgId
      - goalId
      - createId
      - createAt
      properties:
        id:
          type: string
          description: globally unique id
          example: 588f7ee98f138b19220041a7
        orgId:
          type: string
          description: parent organization id
          example: 588f7ee98f138b19220041a7
        goalId:
          type: string
          description: goal id that this progress update belongs to
          example: 588f7ee98f138b19220041a7
        actuals:
          type: array
          description: manually entered values for the current actual progress towards the goal target(s)
          items:
            $ref: '#/components/schemas/GoalTargetActual'
        forecasts:
          type: array
          description: forecasts for where the goal target(s) will be as-of the end date
          items:
            $ref: '#/components/schemas/GoalProgressForecast'
        confidence:
          type: integer
          format: int32
          description: confidence level of the progress update on how overall on-track we are for the goal as whole, on a scale of 0 to 100
        done:
          type: integer
          format: int32
          description: if marking the goal done, how accomplished the goal was, on a scale of 0 to 100
        comment:
          type: string
          description: comment on the progress update
        date:
          type: string
          format: date
          description: effective date of this progress update
        createId:
          type: string
          description: created by user id
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        createAt:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        updateId:
          type: string
          description: last updated by user id
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: last updated timestamp
          example: '2017-01-24T13:57:52Z'
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteBehalfId:
          type: string
          description: deleted on behalf of user id
          example: 588f7ee98f138b19220041a7
        deleteAttribution:
          $ref: '#/components/schemas/Attribution'
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
    ResultsGoalProgress:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GoalProgress'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    ResultsAccess:
      type: object
      required:
      - allowed
      properties:
        ids:
          type: array
          uniqueItems: true
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        allowed:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/AccessAction'
    CreateGoalProgress:
      type: object
      required:
      - goalId
      properties:
        goalId:
          type: string
          description: goal id that this progress update belongs to
          example: 588f7ee98f138b19220041a7
        actuals:
          type: array
          description: manually entered values for the current actual progress towards the goal target(s)
          items:
            $ref: '#/components/schemas/GoalTargetActual'
        forecasts:
          type: array
          description: forecasts for where the goal target(s) will be as-of the end date
          items:
            $ref: '#/components/schemas/GoalProgressForecast'
        confidence:
          type: integer
          format: int32
          description: confidence level of the progress update on how overall on-track we are for the goal as whole, on a scale of 0 to 100
        done:
          type: integer
          format: int32
          description: if marking the goal done, how accomplished the goal was, on a scale of 0 to 100
        comment:
          type: string
          description: comment on the progress update
        date:
          type: string
          format: date
          description: effective date of this progress update
    UpdateGoalProgress:
      type: object
      properties:
        goalId:
          type: string
          description: goal id that this progress update belongs to
          example: 588f7ee98f138b19220041a7
        actuals:
          type: array
          description: manually entered values for the current actual progress towards the goal target(s)
          items:
            $ref: '#/components/schemas/GoalTargetActual'
        forecasts:
          type: array
          description: forecasts for where the goal target(s) will be as-of the end date
          items:
            $ref: '#/components/schemas/GoalProgressForecast'
        confidence:
          type: integer
          format: int32
          description: confidence level of the progress update on how overall on-track we are for the goal as whole, on a scale of 0 to 100
        done:
          type: integer
          format: int32
          description: if marking the goal done, how accomplished the goal was, on a scale of 0 to 100
        comment:
          type: string
          description: comment on the progress update
        date:
          type: string
          format: date
          description: effective date of this progress update
    AccessAction:
      type: object
      required:
      - action
      properties:
        action:
          type: string
        fields:
          type: array
          uniqueItems: true
          items:
            type: string
        types:
          type: array
          uniqueItems: true
          items:
            type: string
    GoalTargetActual:
      type: object
      required:
      - goalTargetId
      properties:
        goalTargetId:
          type: string
          example: 588f7ee98f138b19220041a7
        value:
          anyOf:
          - type: string
          - type: number
          - type: boolean
    GoalProgressForecast:
      type: object
      required:
      - goalTargetId
      - type
      - value
      properties:
        goalTargetId:
          type: string
          example: 588f7ee98f138b19220041a7
        type:
          type: string
          enum:
          - WORST
          - COMMIT
          - CALL
          - LIKELY
          - BEST
        label:
          type: string
        value:
          anyOf:
          - type: string
          - type: number
          - type: boolean