Summary Report

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

Summary Report queries are good for pulling data over custom date ranges, to compare across tests.

Get raw data

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

Note: Response payload can quickly become huge, please use date ranges and limit parameter for a good result set.

Query Parameters

Name
Type
Description

apikey (see note)

string

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",
      "host": "string",
      "domain": "string",
      "path": "string",
      "location": "string",
      "created_at": "2023-07-21T20:21:56.245Z",
      "winner_found_at": "2023-07-21T20:21:56.245Z",
      "stopped_at": "2023-07-21T20:21:56.245Z",
      "num_variants": 0,
      "winning_variant": "string",
      "variant_id": "string",
      "ctr_mean": 0,
      "headline": "string",
      "status": "string",
      "test_duration_sec": 0,
      "sections": "string",
      "created_by": "string"
    }
  ]
}

Last updated