GamebeastDocs
Dashboard

Execute user journey query

POST
/application/{applicationId}/analytics/v1/queries/flows/execute

Execute a user journey (flow) query. Returns the top paths users take to reach, or after reaching, an anchor marker, as step-indexed edges counted in unique users.

Authorization

AuthorizationBearer <token>

Secret server key (prefixed gb_sk_) for server-to-server calls. Send it as Authorization: Bearer <key>. Never ship a secret key in a game client.

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

curl -X POST "https://example.com/application/0/analytics/v1/queries/flows/execute" \  -H "environment_id: 0" \  -H "Content-Type: application/json" \  -d '{    "time": {      "step": "second",      "relative": {        "step": "second",        "value": 0      }    },    "metrics": [      {        "id": "string",        "visible": true,        "data": {          "name": "string",          "type": "event"        }      }    ],    "flowSteps": [      {        "before": 0,        "after": 0      }    ],    "options": {      "display": "line"    }  }'
Empty