GamebeastDocs
Dashboard
Project APIAnnotations

List annotation types

GET
/application/{applicationId}/analytics/v1/annotations/types

The project's annotation types in this environment, with live annotation counts. Gamebeast's own types (experiments) are always present and come first.

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

Query Parameters

includeArchived?string

Header Parameters

environment_id*number

Gamebeast environment ID

Response Body

application/json

curl -X GET "https://example.com/application/0/analytics/v1/annotations/types" \  -H "environment_id: 0"
{  "types": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "icon": "flag",      "color": "chart-1",      "systemKey": "experiment.lifecycle",      "visibleByDefault": true,      "annotationCount": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "archivedAt": "2019-08-24T14:15:22Z"    }  ]}