Account API

The Account API returns information on a token's call volume and billing history.

Request

To use the Account API, perform a HTTP GET request on the following endpoint:

https://api.diffbot.com/v3/account

Provide the following arguments:

ArgumentDescription
tokenDeveloper token
Optional parameters
daysPass the number of days (&days=365) for which you would like to retrieve API call volumes (default = 31).
invoicesPass &invoices=true to return invoice and payment history.

Response

The Account API returns account details in JSON format. Items returned will include the following:

FieldDescription
name
Name associated with the token.
email
Email address associated with the token.
plan
Current plan for the token.
planCalls
Amount of monthly calls included.
status
Status of the token.
childTokens
List of child or sub-tokens, if there are any associated with your account.
apiCalls
An array of days and call volume amounts for each day. By default this will return data from the most recent 31 days. Use the days argument to adjust the response window. Dates prior to token becoming active will not be returned.
date
Date, e.g. 2015-10-01.
calls
Total number of API calls made.
proxyCalls
Total number of calls made using proxy servers. Read more.
giCalls
Total number of search calls made against the Global Index.
invoices
Array of invoices for paid accounts.
date
Date of invoice.
periodStart
Billing period start date (resolved to day).
periodEnd
Billing period end date (resolved to day).
totalCalls
Total calls made during the billing period.
totalAmount
Total amount charged.
overageAmount
Total overage amount billed if call volume exceeded included number of monthly calls.
status
Payment status of invoice (paid or unpaid).