Articles in this section

Quickstats API

Avatar
Owen Allen
Updated

The Quickstats API provides information about your account.

URL

URL: https://api.clickbank.com/rest/1.3/quickstats

Methods

This section provides details about the methods available within the Quickstats API, including required keys and roles, output types, and supported and required parameters.

The following methods are covered in this section:

GET  /1.3/quickstats/schema

This method returns the XML Schema for quickstats results.

Required Keys and Roles

  • None

NOTE: As of July 27, 2023, API keys and API permissions are managed in the API Management section of your primary ClickBank account. To learn more about the difference between your primary account and your account nickname, check out this article.
Related: API Management Improvements & Additional User Permissions Added

 

Return Type

XML Schema for Account Quickstats

Supported Output Types

  • application/xml

GET  /1.3/quickstats/accounts

This method returns a list of all account nicknames for which the current API user has read access.

Required Keys and Roles

  • ClickBank API Key
    • API Order Read Role

NOTE: 

Return Type

List of API Account nicknames

Supported Output Types

  • application/xml
  • application/json

GET  /1.3/quickstats/count

This method returns the sums of the sale, refund and chargeback amounts, for the accounts and time period specified in the search criteria.

Note – The quickStatDate in the returned data is null. The data is returned in the sale, refund, and chargeback elements.

Request Parameters

Name Required Description
account No Return results from the specified account nickname. If you do not specify an account, data is returned for all of your accounts.
endDate No Return results ending with the specified date. The date range is inclusive. The date format is yyyy-mm-dd. The default value is the current day.
startDate No Return results beginning with the specified date. The date range is inclusive. The date format is yyyy-mm-dd. The default value is 45 days prior to today.

Required Keys and Roles

  • ClickBank API Key
    • API Order Read Role

Return Type

Account Quickstats

Supported Output Types

  • application/xml
  • application/json

GET  /1.3/quickstats/list

This method returns daily sale, refund, and chargeback data for the API user, for the accounts and time period specified in the search criteria.

Request Parameters

Name Required Description
account No Return results from the specified account nickname. If you do not specify an account, data is returned for all of your accounts.
endDate No Return results ending with the specified date. The date range is inclusive. The date format is yyyy-mm-dd. The default value is the current day.
startDate No Return results beginning with the specified date. The date range is inclusive. The date format is yyyy-mm-dd. The default value is 45 days prior to today.

Required Keys and Roles

  • ClickBank API Key
    • API Order Read Role

Return Type

Account Quickstats

Supported Output Types

  • application/xml
  • application/json

Return Types

This section details the return types used by the Quickstats API.

The following return types are covered in this section:

Account Quickstats

Account quickstats returns use the following format:

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:cb="http://www.clickbank.com/api" version="1.0">
<xs:element name="accountData" type="accountData"/>
<xs:element name="quickstatsData" type="quickstatsData"/>
<xs:complexType name="accountData">
<xs:sequence>
<xs:element name="nickName" type="xs:string" nillable="true" minOccurs="0"/>
<xs:element name="quickStats" type="quickstatsData" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="quickstatsData">
<xs:sequence>
<xs:element name="quickStatDate" type="xs:dateTime" nillable="true" minOccurs="0"/>
<xs:element name="sale" type="xs:decimal" nillable="true" minOccurs="0"/>
<xs:element name="refund" type="xs:decimal" nillable="true" minOccurs="0"/>
<xs:element name="chargeback" type="xs:decimal" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

Usage Information

For additional information about using the Quickstats API, see the ClickBank APIs article.

Related Articles

Related articles