Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Charthop goal API

The goal API from Charthop — 5 operation(s) for goal.

Charthop goal API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include goal. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 5 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

8 operations 5 paths 16 schemas 1 DELETE3 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
Resource Areas
1

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

goal 8
GET
/v1/org/{orgId}/goal
Find goals
findGoals 9 params → 200400401404
POST
/v1/org/{orgId}/goal
Create a new goal
createGoal 2 params → 201400401403404
POST
/v1/org/{orgId}/goal/export
Export goals to CSV format
exportGoals 4 params → 201401403404
GET
/v1/org/{orgId}/goal/{goalId}
Get a goal by id
getGoal 2 params → 200400401404
PATCH
/v1/org/{orgId}/goal/{goalId}
Update an existing goal
updateGoal 3 params → 200400401403404
DELETE
/v1/org/{orgId}/goal/{goalId}
Delete a goal
deleteGoal 2 params → 204400401403404
POST
/v1/org/{orgId}/goal/{goalId}/copy
Copy a goal and its targets into a new goal
copyGoal 3 params → 201400401403404
GET
/v1/org/{orgId}/goal/{goalId}/graph
Find parent and child goals, from a starting goal id
findGoalsGraph 5 params → 200400401404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Goal (31 properties), Process (29 properties), UpdateGoal (15 properties), CreateGoal (15 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
Goal
object
31 properties 10 required
GoalTargetWithValue
object
4 properties 3 required
ResultsAccess
object
2 properties 1 required
GoalTargetActual
object
2 properties 1 required
Process
object
29 properties 9 required
LogData
object
4 properties 3 required
ResultsGoal
object
3 properties 1 required
GoalProgressForecast
object
4 properties 3 required
MessageChannelConfig
object
2 properties 2 required
CreateGoal
object
15 properties 5 required
ShareAccess
object
4 properties 1 required
Attribution
object
6 properties
GoalProgressSummary
object
10 properties
GoalProgressUpdateConfig
object
3 properties 1 required
UpdateGoal
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-goal-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API