Get Impressions Usage Summary

1 min

GET

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

Get Impressions Usage Summary by account id

Path Parameters

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

Responses

200Return Impression Usage Summary for account

ImpressionsUsageSummary
- allowanceinteger<int64>required
  Example
  25000000
  Description
  Total allowance purchased for the account.
  Format
  int64
- end_datestring<date>required
  Description
  Current subscription end date.
  Format
  date
  Pattern
  ^\d{4}-\d{2}-\d{2}
- last_update_datestring<date>required
  Description
  Last impressions usage updated date.
  Format
  date
  Pattern
  ^\d{4}-\d{2}-\d{2}
- start_datestring<date>required
  Description
  Current subscription start date.
  Format
  date
  Pattern
  ^\d{4}-\d{2}-\d{2}
- usageinteger<int64>required
  Example
  16360512
  Description
  Usage for the account.
  Format
  int64
- usage_percentagenumberrequired
  Example
  65
  Description
  Utilised usage percentage.
  Minimum
  0
  Maximum
  100

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 Summary 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}/summary \
     --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}/summary", 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}/summary")

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}/summary"

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 Summary for account
{
  "allowance": 25000000,
  "end_date": "",
  "last_update_date": "",
  "start_date": "",
  "usage": 16360512,
  "usage_percentage": 65
}

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 Summary not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

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