Analytics Queries

Read saved query execution state

Changed on

Return the current state of a saved query's execution without starting one. Used to recover after a remount or a dropped websocket, so a client never has to re-POST (and duplicate work) just to learn an outcome. Takes the same override body as execute so it can resolve the same variant. POST is used only to carry that body.

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

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