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-type API

The goal-type API from Charthop — 2 operation(s) for goal-type.

Charthop goal-type 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-type. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

5 operations 2 paths 13 schemas 1 DELETE2 GET1 PATCH1 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 5

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

goal-type 5
GET
/v1/org/{orgId}/goal-type
Find goal types
findGoalTypes 4 params → 200400401404
POST
/v1/org/{orgId}/goal-type
Create a new goal type
createGoalType 2 params → 201400401403404
GET
/v1/org/{orgId}/goal-type/{goalTypeId}
Get a goal type by id
getGoalType 2 params → 200400401404
PATCH
/v1/org/{orgId}/goal-type/{goalTypeId}
Update an existing goal type
updateGoalType 3 params → 200400401403404
DELETE
/v1/org/{orgId}/goal-type/{goalTypeId}
Delete a goal type
deleteGoalType 2 params → 204400401403404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are GoalType (23 properties), UpdateGoalType (9 properties), CreateGoalType (9 properties), EnumValue (9 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
EnumValue
object
9 properties 2 required
GoalType
object
23 properties 2 required
ResultsGoalType
object
3 properties 1 required
UpdateGoalType
object
9 properties
Translations
object
1 property 1 required
MessageChannelConfig
object
2 properties 2 required
Attribution
object
6 properties
CreateGoalType
object
9 properties 1 required
GoalProgressUpdateConfig
object
3 properties 1 required
GoalTargetValueType
object
4 properties 2 required
GoalForecastType
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-goal-type-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