Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Impressions Usage

Get Impressions Usage

Get Impressions Usage by account id

get/billing/usage/{account_id}

Path parameters

account_idinteger required

The account ID of the customer

Query parameters

per_pageinteger

Optional pagination argument that specifies the maximum number of objects to return per request

pageinteger

Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.

usage_date_fromstring required

Start date of date range

usage_date_tostring required

End date of date range

platformsstring[]

The platform of the Project

querystring

Search by experiment_id, project_id.

sortstring

The property to sort by.

orderstring

The property to sort by.

Response

Return Impression Usage info for account

experiment_idinteger required

The ID for the experiment.

experiment_namestring required

The Experiment name to display in the Optimizely app. Whitespaces and other non-alphanumeric characters allowed. Defaults to experiment key if left empty.

experiment_statusstring required

The status of the Experiment.

impression_countinteger required

The Impressions count at experiment level.

platformstring required

The platform of the Project

project_idinteger required

The ID for the project.

project_namestring required

The name of the Project.

Example response

[
  {
    "experiment_id": 3239,
    "experiment_name": "Renewable energy",
    "experiment_status": "Running, Not started",
    "impression_count": 322010712450,
    "platform": "web, fullstack, edge",
    "project_id": 3094,
    "project_name": "Landing Page Optimization"
  }
]