Charthop

Charthop goalTarget API

The goalTarget API from Charthop — 3 operation(s) for goaltarget.

GitHub OpenAPI

Operations 6

GET /v1/org/{orgId}/goal/{goalId}/target Find goal targets for a goal #
POST /v1/org/{orgId}/goal/{goalId}/target Create a new goal target #
GET /v1/org/{orgId}/goal/{goalId}/target/{goalTargetId} Get a goal target by id #
PATCH /v1/org/{orgId}/goal/{goalId}/target/{goalTargetId} Update an existing goal target #
DELETE /v1/org/{orgId}/goal/{goalId}/target/{goalTargetId} Delete a goal target #
GET /v1/org/{orgId}/goal/{goalId}/target/{goalTargetId}/actual Get a goal target's current actual value #

Documentation

📖
Documentation
https://docs.charthop.com/developer-basics

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-goaltarget-api-openapi.yml

Other Resources

🔗
Swagger
https://api.charthop.com/swagger

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-goaltarget-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.

GitHub Google LinkedIn

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

OpenAPI Specification

charthop-goaltarget-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Goal Target API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: goalTarget
paths:
  /v1/org/{orgId}/goal/{goalId}/target:
    get:
      tags:
      - goalTarget
      summary: Find goal targets for a goal
      operationId: findGoalTargets
      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: 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/ResultsGoalTarget'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - goalTarget
      summary: Create a new goal target
      operationId: createGoalTarget
      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
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalTarget'
        '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/CreateGoalTarget'
        description: Goal target data to create
        required: true
  /v1/org/{orgId}/goal/{goalId}/target/{goalTargetId}:
    get:
      tags:
      - goalTarget
      summary: Get a goal target by id
      operationId: getGoalTarget
      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: goalTargetId
        in: path
        description: Goal target id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalTarget'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    patch:
      tags:
      - goalTarget
      summary: Update an existing goal target
      operationId: updateGoalTarget
      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: goalTargetId
        in: path
        description: Goal target id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalTarget'
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateGoalTarget'
        description: Goal target data to update
        required: true
    delete:
      tags:
      - goalTarget
      summary: Delete a goal target
      operationId: deleteGoalTarget
      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: goalTargetId
        in: path
        description: Goal target 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
  /v1/org/{orgId}/goal/{goalId}/target/{goalTargetId}/actual:
    get:
      tags:
      - goalTarget
      summary: Get a goal target's current actual value
      operationId: getGoalTargetActual
      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: goalTargetId
        in: path
        description: Goal target id
        required: true
        schema:
          type: string
      - name: date
        in: query
        description: Effective date
        required: false
        schema:
          type: string
          format: date
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoalTargetActual'
        '400':
          description: bad request
        '401':
          description: not authorized
        '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
    UpdateGoalTarget:
      type: object
      properties:
        goalId:
          type: string
          description: goal id that this target belongs to
          example: 588f7ee98f138b19220041a7
        label:
          type: string
          description: human-readable name of the goal target
          example: Increase Revenue at least 10% in Q1
        slug:
          type: string
          description: url-safe slug for the goal target, auto-generated from goal slug and label if not provided
        startValue:
          description: starting point value for this target, as-of the date of the goal
          example: '100000'
          anyOf:
          - type: string
          - type: number
          - type: boolean
        targetValues:
          type: array
          description: potential target values we're working to achieve
          items:
            $ref: '#/components/schemas/GoalTargetValue'
        direction:
          type: string
          description: direction of the target -- whether we want to minimize or maximize the value
          enum:
          - MINIMIZE
          - MAXIMIZE
          - TARGET
        type:
          type: string
          description: type of the target value
          enum:
          - MILESTONE
          - MONEY
          - PERCENT
          - INTEGER
          - DECIMAL
        valueExpr:
          type: string
          description: Carrot expression used to compute the current value versus target -- if not provided, GoalProgress will be used to track progress
        startDate:
          type: string
          format: date
          description: start date for this goal target
        endDate:
          type: string
          format: date
          description: end date for this goal target
    GoalTargetValue:
      type: object
      required:
      - value
      properties:
        targetValueTypeId:
          type: string
          description: the type of the target value (for example, 'Stretch' vs 'Minimum'), extracted from the goal type's targetValues
          example: 588f7ee98f138b19220041a7
        value:
          description: target value to achieve (should be a numeric value, either number, money, or percentage)
          example: '100000'
          anyOf:
          - type: string
          - type: number
          - type: boolean
    CreateGoalTarget:
      type: object
      required:
      - goalId
      - type
      - startDate
      - endDate
      properties:
        goalId:
          type: string
          description: goal id that this target belongs to
          example: 588f7ee98f138b19220041a7
        label:
          type: string
          description: human-readable name of the goal target
          example: Increase Revenue at least 10% in Q1
        slug:
          type: string
          description: url-safe slug for the goal target, auto-generated from goal slug and label if not provided
        startValue:
          description: starting point value for this target, as-of the date of the goal
          example: '100000'
          anyOf:
          - type: string
          - type: number
          - type: boolean
        targetValues:
          type: array
          description: potential target values we're working to achieve
          items:
            $ref: '#/components/schemas/GoalTargetValue'
        direction:
          type: string
          description: direction of the target -- whether we want to minimize or maximize the value
          enum:
          - MINIMIZE
          - MAXIMIZE
          - TARGET
        type:
          type: string
          description: type of the target value
          enum:
          - MILESTONE
          - MONEY
          - PERCENT
          - INTEGER
          - DECIMAL
        valueExpr:
          type: string
          description: Carrot expression used to compute the current value versus target -- if not provided, GoalProgress will be used to track progress
        startDate:
          type: string
          format: date
          description: start date for this goal target
        endDate:
          type: string
          format: date
          description: end date for this goal target
    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'
    GoalTarget:
      type: object
      required:
      - id
      - orgId
      - goalId
      - type
      - startDate
      - endDate
      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 target belongs to
          example: 588f7ee98f138b19220041a7
        label:
          type: string
          description: human-readable name of the goal target
          example: Increase Revenue at least 10% in Q1
        slug:
          type: string
          description: url-safe slug for the goal target, auto-generated from goal slug and label if not provided
        startValue:
          description: starting point value for this target, as-of the date of the goal
          example: '100000'
          anyOf:
          - type: string
          - type: number
          - type: boolean
        targetValues:
          type: array
          description: potential target values we're working to achieve
          items:
            $ref: '#/components/schemas/GoalTargetValue'
        direction:
          type: string
          description: direction of the target -- whether we want to minimize or maximize the value
          enum:
          - MINIMIZE
          - MAXIMIZE
          - TARGET
        type:
          type: string
          description: type of the target value
          enum:
          - MILESTONE
          - MONEY
          - PERCENT
          - INTEGER
          - DECIMAL
        valueExpr:
          type: string
          description: Carrot expression used to compute the current value versus target -- if not provided, GoalProgress will be used to track progress
        startDate:
          type: string
          format: date
          description: start date for this goal target
        endDate:
          type: string
          format: date
          description: end date for this goal target
        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'
    ResultsGoalTarget:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GoalTarget'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    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