Getting Started with our Headline Testing API
Get familiar with our Headline Testing API for fetching headline testing data with specified start and end times.
Last updated
Was this helpful?
Get familiar with our Headline Testing API for fetching headline testing data with specified start and end times.
Last updated
Was this helpful?
Our Headline Testing API endpoints can be used to retrieve active and archive headline test data for your site in JSON format programmatically.
API Key: To be passed in the HTTP Header with "X-CB-AK". You can create and access your under your account settings. Make sure to select an API key that has access to all calls for your domain.
curl --header "X-CB-AK: <YOUR API KEY>" "https://api.chartbeat.com/mab/htapi/v1/experiments/raw_data/?host=YOUR_HOST.com&start=2024-01-01&end=2024-01-01&tz=America/New_York&status=active"
The following parameters are necessary to include in all queries:
Parameter Name
Syntax
Description
API Key (see note)
apikey=
Host
host=
The Site you are querying (site ID is usually your website's root domain).
Start Date
start=
A valid date string in YYYY-MM-DD format.
End Date
end=
A valid date string in YYYY-MM-DD format.
Timezone
tz=
The timezone you'd like to run the query in a valid Olson timezone format, e.g. America/New_York.
Raw data returns comprehensive details about each headline test.
Parameter Name
Syntax
Description
Status
status=
Status of the headline test. Choose from 'active', 'archived', 'all'. Defaults to 'all'. Note that this parameter is only available for raw data endpoint.
Limit
limit=
The number of rows you'd like to pull in your query. Large calls are susceptible to 504 gateway timeouts, so we recommend setting no more than 10,000 rows.
Test Type
test_type=
Chose from "headline","image","headline_and_image". Defaults to "all" which includes all 3.
Check out the next three pages of this guide to find all the information you need to get started using our Headline Testing API.
NOTE: Your API key should no longer be set as a query param; instead,