get https://api.diffbot.com/v4/account
Returns account plan, usage, child tokens, and other account details.
Response
The Account API returns account details in JSON format. Items returned will include the following:
Field | Description |
---|---|
name | Name associated with the token. |
email | Email address associated with the token. |
plan | Current plan for the token. |
planCredits | 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. |
usage | 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. 2019-12-01 . |
↳nlp | Total number of Natural Language API calls made. |
↳credits | Total number of credits consumed. |
↳extractions | Total number of Extraction API calls made. |
↳proxies | Total number of calls made using proxy servers. Read more. |
↳entities | Total number of entities downloaded from the Diffbot Knowledge Graph. |
↳refresh | Total number of entity refreshes requested. |
↳facets | Total number of facet values returned. |
↳videos | Total number of videos downloaded. |
↳subtitles | Total number of subtitles requested. |
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). |
↳totalCredits | Total credits used 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 ). |