Docs Suite

Docs Suite

  • Debugging

›API

Account API

    Basics

    • Introduction
    • Basic Usage

    Recipes

    • Index

    API

    • Account API
Edit

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/v4/account

Provide the following arguments:

ArgumentDescription
tokenDeveloper token
Optional arguments
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
nameName associated with the token.
emailEmail address associated with the token.
planCurrent plan for the token.
planCreditsAmount of monthly calls included.
statusStatus of the token.
childTokensList of child or sub-tokens, if there are any associated with your account.
usageAn 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.
↳dateDate, e.g. 2019-12-01.
↳creditsTotal number of credits consumed.
↳extractionsTotal number of Extraction API calls made.
↳proxiesTotal number of calls made using proxy servers. Read more.
↳entitiesTotal number of entities downloaded from the Diffbot Knowledge Graph.
↳refreshTotal number of entity refreshes requested.
↳facetsTotal number of facet values returned.
↳videosTotal number of videos downloaded.
↳subtitlesTotal number of subtitles requested.
invoicesArray of invoices for paid accounts.
↳dateDate of invoice.
↳periodStartBilling period start date (resolved to day).
↳periodEndBilling period end date (resolved to day).
↳totalCreditsTotal credits used during the billing period.
↳totalAmountTotal amount charged.
↳overageAmountTotal overage amount billed if call volume exceeded included number of monthly calls.
↳statusPayment status of invoice (paid or unpaid).
Last updated by miketung
← Index
  • Request
  • Response
Docs Suite
Docs
ExtractionCrawlingKnowledge GraphDiffbot and GDPR
Community
Stack OverflowTwitter
More
BlogHelpGitHub
Diffbot.com
Copyright © 2021 Diffbot.com