Analytics Queries

Request saved query execution (async)

Changed on

Start (or join) an asynchronous execution of a saved query. Returns immediately with an executionId rather than waiting for ClickHouse; the result arrives over the analytics websocket, or can be recovered from GET /queries/:queryId/executions. Concurrent requests for the same resolved variant share one execution. Responds 202 while work is in progress and 200 when data is returned inline.

post/application/{applicationId}/analytics/v1/queries/{queryId}/executions

Request

  • Base URL
    https://api.gamebeast.gg
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

applicationIdnumber required

Gamebeast project ID

queryIdnumber required

Headers

environment_idnumber required

Gamebeast environment ID

Request body

boardIdnumber
refreshboolean
maxAgeSecondsinteger

Response

Default Response

status'ready' | 'stale' | 'queued' | 'computing' | 'failed' required
executionIdstring
dataunknown
refreshedAtstring
executionMsnumber
startedAtstring
dedupJoinersnumber
variantTokenstring

Changes

    • info

      the request property //// became optional

    • info

      added the new flowed_steps enum value to the request property /

    • info

      added the new funnel_table enum value to the request property /

    • breaking

      removed subschema #1 subschema #2 from the request property anyOf list

    • breaking

      removed subschema #4 subschema #9 from the // request property oneOf list

    • info

      the endpoint scheme security cookieAuth was removed from the API

    • info

      added subschema #1 subschema #2 to the request property anyOf list

    • info

      the request property's exclusiveMinimum was decreased from true to 0.00

    • info

      added subschema #4 subschema #9 to the // request property oneOf list