Get Impressions Usage

1 min

GET

https://api.optimizely.com/v2/billing/usage/{account_id}

Get Impressions Usage by account id

Path Parameters

account_idinteger<int64>required
Description
The account ID of the customer
Format
int64

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
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.
Default
1
usage_date_fromstringrequired
Description
Start date of date range
Pattern
^\d{4}-\d{2}-\d{2}$
usage_date_tostringrequired
Description
End date of date range
Pattern
^\d{4}-\d{2}-\d{2}$
platformsstring[]
Description
The platform of the Project
Default
edge,fullstack,web
querystring
Description
Search by experiment_id, project_id.
Default
sortstring
Description
The property to sort by.
Default
impression_count
orderstring
Description
The property to sort by.
Default
desc

Responses

200Return Impression Usage info for account

ImpressionsUsage[]
- experiment_idinteger<int64>required
  Example
  3239
  Description
  The ID for the experiment.
  Format
  int64
- experiment_namestringrequired
  Example
  Renewable energy
  Description
  The Experiment name to display in the Optimizely app. Whitespaces and other non-alphanumeric characters allowed. Defaults to experiment key if left empty.
- experiment_statusstringrequired
  Example
  Running, Not started
  Description
  The status of the Experiment.
- impression_countinteger<int64>required
  Example
  322010712450
  Description
  The Impressions count at experiment level.
  Format
  int64
- platformstringrequired
  Example
  web, fullstack, edge
  Description
  The platform of the Project
  Default
  web
- project_idinteger<int64>required
  Example
  3094
  Description
  The ID for the project.
  Format
  int64
- project_namestringrequired
  Example
  Landing Page Optimization
  Description
  The name of the Project.

400Invalid ID

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to account

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Impression Usage not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/billing/usage/{account_id}?per_page=25&page=1&usage_date_from=string&usage_date_to=string&platforms=edge%2Cfullstack%2Cweb&query=string&sort=impression_count&order=desc' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/billing/usage/{account_id}?per_page=25&page=1&usage_date_from=string&usage_date_to=string&platforms=edge,fullstack,web&query=string&sort=impression_count&order=desc", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/billing/usage/{account_id}?per_page=25&page=1&usage_date_from=string&usage_date_to=string&platforms=edge,fullstack,web&query=string&sort=impression_count&order=desc")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/billing/usage/{account_id}?per_page=25&page=1&usage_date_from=string&usage_date_to=string&platforms=edge,fullstack,web&query=string&sort=impression_count&order=desc"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return Impression Usage info for account
[
  {
    "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"
  }
]

400

// Invalid ID
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to account
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Impression Usage not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}