CorrelationMetrics available for this client

Metrics available for this client

Real discovery, not a static list: the event families are built from the event names actually captured in the window, and the Meta metrics are marked unavailable when the client has no ads-insights table. Value metrics (revenue:, new_revenue:) appear only for events that actually carry a value at revenue_path — otherwise the series would be a flat zero, which reads as "no relationship" rather than "wrong path".

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/correlation/metrics?location_id=example_string&lookback_days=90&revenue_path=%24.value" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "window": {
    "from": "example_string",
    "to": "example_string"
  },
  "revenue_path": "$.value",
  "sources": {},
  "metrics": [
    {
      "id": "spend",
      "label": "Ad spend (Meta)",
      "unit": "count",
      "source": "events",
      "available": true,
      "occurrences": 42
    }
  ],
  "note": "example_string"
}
GET
/client/v1/correlation/metrics
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_). Scoped keys (mcp_) are accepted too and need correlation:read. See Using an mcp_ key over HTTP.

Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need correlation:read. See Using an mcp_ key over HTTP.
query
location_idstring

Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_.

query
lookback_daysinteger

Window used to find event names.

Min: 2 • Max: 730
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_). Scoped keys (mcp_) are accepted too and need correlation:read. See Using an mcp_ key over HTTP.

Query Parameters

location_idstring

Location to scope to. Required for ak_ keys (or send the X-Location-Id header); ignored for sk_.

lookback_daysinteger

Window used to find event names.

Responses

successboolean
windowobject
revenue_pathstring
sourcesobject

Which backing tables exist for this client.

metricsarray
notestring

Present when the Meta table is missing, explaining what to provision.