Events & ExportBigQuery export status

BigQuery export status

Resolve the BigQuery export dataset coordinates. Two grains:

Per-location (recommended): pass a location_id with an agency (ak_) key, or use a location secret (sk_) key, to resolve that client's IAM-isolated dataset mythic-data.client_<location_id> (grain: "location"). A per-client reader service account is granted READER on this dataset only.

Agency-wide: an ak_ key with no location returns the agency dataset mythic-data.agency_<id> spanning all linked locations (grain: "agency").

Resolve coordinates here rather than hand-computing dataset names.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/data/export?location_id=example_string" \
  -H "Content-Type: application/json" \
  -H "X-Location-Id: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "dataset": "mythic-data.client_acme_retail",
    "grain": "location",
    "location_id": "example_string",
    "tables": [
      "events",
      "person_events",
      "sessions",
      "attribution_default",
      "person_profiles",
      "identities",
      "person_merges"
    ],
    "location_count": 10,
    "status": "example_string",
    "provisioned_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z"
  }
}
GET
/export
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) or location secret key (sk_) as a bearer token. Format: Bearer ak_... or Bearer sk_.... Scoped keys (mcp_) are accepted too and need the read scope of the family the route belongs to (people, events, sessions, replays, exceptions, heatmaps or bigquery_export). See Using an mcp_ key over HTTP.

Agency key (ak_) or location secret key (sk_) as a bearer token. Format: Bearer ak_... or Bearer sk_.... Scoped keys (mcp_) are accepted too and need the read scope of the family the route belongs to (people, events, sessions, replays, exceptions, heatmaps or bigquery_export). See Using an mcp_ key over HTTP.
query
location_idstring

Alternative to the X-Location-Id header for agency (ak_) keys. Ignored for secret (sk_) keys.

header
X-Location-Idstring

Location to scope the request to. Required for agency (ak_) keys on the event routes. Ignored for secret (sk_) keys, which resolve their own location, and not used by /export.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) or location secret key (sk_) as a bearer token. Format: Bearer ak_... or Bearer sk_.... Scoped keys (mcp_) are accepted too and need the read scope of the family the route belongs to (people, events, sessions, replays, exceptions, heatmaps or bigquery_export). See Using an mcp_ key over HTTP.

Query Parameters

location_idstring

Alternative to the X-Location-Id header for agency (ak_) keys. Ignored for secret (sk_) keys.

Headers

X-Location-Idstring

Location to scope the request to. Required for agency (ak_) keys on the event routes. Ignored for secret (sk_) keys, which resolve their own location, and not used by /export.

Responses

successboolean
dataobject