Variant Report

Variant Report data endpoint is designed to fetch summary of variants ran over a custom time range. Please note that active tests are not included.

Variant report queries are good for pulling data over custom date ranges, to comparisons across variants, regardless of headline test.

Get raw data

GET https://api.chartbeat.com/mab/htapi/v1/experiments/variant_report/

Note: The payload can quickly become large, please use date ranges and limit parameter for good result set.

Query Parameters

NameTypeDescription

apikey (see note)

string

NOTE: Your API key should no longer be set as a query param; instead, pass it in the HTTP header

start*

string

YYYY-MM-DD

end*

string

YYYY-MM-DD

host*

string

The site on which you are querying

tz*

string

The timezone you'd like to run the query in a valid Olson timezone format, e.g. America/New_York.

test_type

string

Chose from "headline","image","headline_and_image". Defaults to "all" which includes all 3.

{
  "status": "string",
  "data": {
    "test_id": "string",
    "test_type": "string",
    "created_at": "2023-07-21T20:22:41.589Z",
    "domain": "string",
    "path": "string",
    "headline_id": "string",
    "headline": "string",
    "is_winner": true,
    "views": 0,
    "clicks": 0,
    "engaged_clicks": 0,
    "ctr_mean_percent": 0,
    "winning_variant": "string",
    "status": "string"
  }
}

Last updated