GamebeastDocs
Dashboard
Project APIAnnotations

Create an annotation

POST
/application/{applicationId}/analytics/v1/annotations/

A point (omit endsAt) or a range on every time chart of the project. Answers 201 when created, and 200 with the original when idempotencyKey was used before.

Authorization

personalAccessTokenAuth
AuthorizationBearer <token>

Personal access token (prefixed gb_pat_). Acts on behalf of its owner and can never exceed the owner's own permissions. Send it as Authorization: Bearer <token>.

In: header

Path Parameters

applicationId*number

Gamebeast project ID

Header Parameters

environment_id*number

Gamebeast environment ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/application/0/analytics/v1/annotations/" \  -H "environment_id: 0" \  -H "Content-Type: application/json" \  -d '{    "typeId": "caab7c42-4ce7-4bd5-bbab-6017cec730b7",    "name": "string",    "startsAt": "2019-08-24T14:15:22Z"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "type": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "icon": "flag",    "color": "chart-1",    "systemKey": "experiment.lifecycle"  },  "name": "string",  "description": "string",  "startsAt": "2019-08-24T14:15:22Z",  "endsAt": "2019-08-24T14:15:22Z",  "openEnded": true,  "url": "string",  "source": "user",  "createdBy": {    "userId": "string",    "name": "string"  },  "sourceRef": "string",  "editable": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}