ExperimentsRank control markets

Rank control markets

Daily revenue by region over a lookback window (default 90 days), with candidate control markets ranked by Pearson correlation of daily revenue against the proposed test set. Use this to design a test: propose test_regions, take the top-correlated candidates as controls. Omit test_regions to just inventory revenue by region.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/incrementality/markets?test_regions=example_string&lookback_days=90&event_name=John%20Doe&json_path=example_string&measure=revenue" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "window": {
      "from": "2026-05-01",
      "to": "2026-05-31"
    },
    "test_regions": [
      "example_string"
    ],
    "test_total_revenue": 3.14,
    "days": 42,
    "candidates": [
      {
        "region": "Ohio",
        "correlation": 0.93,
        "total_revenue": 3.14,
        "volume_ratio": 3.14
      }
    ]
  }
}
GET
/client/v1/incrementality/markets
GET
Base URLstring

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

Bearer Token
Bearer Tokenstring
Required

Client key as bearer token. Use an agency key (Bearer ak_...) for read-write access or a location secret key (Bearer sk_...) for read-only access. Scoped keys (mcp_) are accepted too and need incrementality:read or incrementality:write. See Using an mcp_ key over HTTP.

Client key as bearer token. Use an agency key (Bearer ak_...) for read-write access or a location secret key (Bearer sk_...) for read-only access. Scoped keys (mcp_) are accepted too and need incrementality:read or incrementality:write. See Using an mcp_ key over HTTP.
query
test_regionsstring

Comma-separated proposed test regions (e.g. California,Texas).

query
lookback_daysinteger

Days of history to correlate over. Default 90, min 14, max 365.

query
event_namestring

Conversion event name (default purchase).

query
json_pathstring

JSON path to revenue in properties_json (default $.value — properties_json IS the event's properties object).

query
measurestring

revenue (default) sums the value at json_path; count counts matching events instead — the lead-gen mode (e.g. ?event_name=form_submitted&measure=count).

Options: revenue, count
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Client key as bearer token. Use an agency key (Bearer ak_...) for read-write access or a location secret key (Bearer sk_...) for read-only access. Scoped keys (mcp_) are accepted too and need incrementality:read or incrementality:write. See Using an mcp_ key over HTTP.

Query Parameters

test_regionsstring

Comma-separated proposed test regions (e.g. California,Texas).

lookback_daysinteger

Days of history to correlate over. Default 90, min 14, max 365.

event_namestring

Conversion event name (default purchase).

json_pathstring

JSON path to revenue in properties_json (default $.value — properties_json IS the event's properties object).

measurestring

revenue (default) sums the value at json_path; count counts matching events instead — the lead-gen mode (e.g. ?event_name=form_submitted&measure=count).

Allowed values:revenuecount

Responses

successboolean
dataobject