Analytics API

 The Analytics API provides account and subscription analytics information.

The following subjects are covered in this article:

• URL
• Methods
• Return Types
• Usage Information
• Related Articles

URL

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

Methods

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

The following methods are covered in this section:

• GET  /1.3/analytics/status – Returns the status and last update time of the API.
• GET  /1.3/analytics/schema/AnalyticsResult – Returns the XML schema for analytics results.
• GET  /1.3/analytics/schema/AnalyticsStatus – Returns the XML schema for analytics status results.
• GET  /1.3/analytics/schema/SubscriptionDetailResult – Returns the XML schema for subscription results.
• GET  /1.3/analytics/schema/SubscriptionTrendsData – Returns the XML schema for subscription trends results.
• GET  /1.3/analytics/schema/SubscriptionDetailResultRow – Returns the XML schema for individual subscription results.
• GET  /1.3/analytics/{role}/{dimension} – Returns statistical data for the given role and dimension.
• GET  /1.3/analytics/{role}/{dimension}/summary – Returns a summary of statistical data for the given role and dimension.
• GET  /1.3/analytics/{role}/subscription/details – Returns subscription details for the given role.
• GET  /1.3/analytics/{role}/subscription/details/canceldate – Returns a list of subscriptions which were canceled within the specified date range.
• GET  /1.3/analytics/{role}/subscription/details/cancelsixty – Returns a list of subscriptions that have been canceled in the last sixty days.
• GET  /1.3/analytics/{role}/subscription/details/cancelthirty – Returns a list of subscriptions that have been canceled in the last thirty days.
• GET  /1.3/analytics/{role}/subscription/details/compsixty – Returns a list of subscriptions that will complete in the next sixty days.
• GET  /1.3/analytics/{role}/subscription/details/compthirty – Returns a list of subscriptions that will complete in the next thirty days.
• GET  /1.3/analytics/{role}/subscription/details/nextpmtdate – Returns a list of subscriptions for which the next payment date is within the specified date range.
• GET  /1.3/analytics/{role}/subscription/details/startdate – Returns a list of subscriptions for which the start date is within the specified date range.
• GET  /1.3/analytics/{role}/subscription/details/status – Returns subscription status data for the given role.
• GET  /1.3/analytics/{role}/subscription/trends – Returns statistical summations of subscription data for a specified date range.

GET  /1.3/analytics/status

This method returns the status and last update time of the API.

The possible statuses are:

• GREEN – Normal operation.
• YELLOW – Delayed data.
• RED – Severely delayed data or critical problem.

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Analytics Status

Supported Output Types

• application/xml
• application/json
• text/csv

GET  /1.3/analytics/schema/AnalyticsResult

This method returns the XML Schema for analytics results.

Required Keys and Roles

• None

Return Type

XML Schema for Analytics Result

Supported Output Types

• application/xml

GET  /1.3/analytics/schema/AnalyticsStatus

This method returns the XML Schema for analytics status results.

Required Keys and Roles

• None

Return Type

XML Schema for Analytics Status

Supported Output Types

• application/xml

GET  /1.3/analytics/schema/SubscriptionDetailResult

This method returns the XML Schema for subscription results.

Required Keys and Roles

• None

Return Type

XML Schema for Subscription Detail Result

Supported Output Types

• application/xml

GET  /1.3/analytics/schema/SubscriptionTrendsData

This method returns the XML Schema for subscription trends results.

Required Keys and Roles

• None

Return Type

XML Schema for Subscription Trends Data

Supported Output Types

• application/xml

GET  /1.3/analytics/schema/SubscriptionDetailResultRow

This method returns the XML Schema for individual subscription results.

Required Keys and Roles

• None

Return Type

XML Schema for Subscription Detail Result Row

Supported Output Types

• application/xml

GET  /1.3/analytics/{role}/{dimension}

This method returns statistical data for a given role and dimension. Valid roles include:

• AFFILIATE
• VENDOR

Dimensions include:

• AFFILIATE
• VENDOR_CATEGORY
• CUSTOMER_CURRENCY
• CUSTOMER_COUNTRY
• CUSTOMER_PROVINCE
• CUSTOMER_LANGUAGE
• PRODUCT_SKU – This dimension can only be used with the vendor role.
• TRACKING_ID
• VENDOR
• VENDOR_PRODUCT_SKU – This dimension can only be used with the affiliate role.

Head Parameters

Name	Required	Description
page	No	Return the specified page of results. The default is page 1.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
dimensionFilter	No	Limits the results returned to ones with a matching dimension ID. This value is case sensitive.
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. Refunds are included or excluded based on the date of the initial purchase transaction.
orderBy	No	Order the results by the specified data field. The valid values are: CHARGEBACK_AMOUNT – The amount of money returned through chargebacks. CHARGEBACK_COUNT – The total number of chargebacks. CHARGEBACK_RATE – The rate of chargebacks as a percentage of total sales. DIMENSION_VALUE – The dimension value. EARNINGS_PER_HOP – The average amount earned for each user who follows a hoplink. GROSS_SALE_AMOUNT – The total monetary amount of sales, including sales that have been refunded or charged back. GROSS_SALE_COUNT – The total number of sales, including sales that have been refunded or charged back. HOP_COUNT – The total number of users who have followed a hoplink connected to the specified account. HOPS_PER_SALE – The number of hops for each sale. HOPS_PER_ORDER_FORM_IMPRESSION – The number of hops for each viewing of the order form. NET_SALE_AMOUNT – The total monetary amount of sales, minus refunds and chargebacks. NET_SALE_COUNT – The total number of sales, minus refunds and chargebacks. ORDER_FORM_SALE_CONVERSION – The conversion rate between order form impressions and sales. ORDER_IMPRESSION – The number of times your order form has been served to potential customers. ORDER_SUBMISSION – The number of times your order form has been submitted by a customer, regardless of result. REBILL_AMOUNT – The total monetary amount of rebill payments made to you. REBILL_COUNT – The total number of rebill payments made to you. REFUND_AMOUNT – The amount of money returned through refunds. REFUND_COUNT – The total number of refunds. REFUND_RATE – The rate of refunds as a percentage of total sales. SALE_AMOUNT – The total monetary amount of initial sales, including one-time products and the initial purchases of recurring products. SALE_COUNT – The total number of initial sales, including one-time products and the initial purchases of recurring products. UPSELL_AMOUNT – The total monetary amount earned through pitchplus upsell flows. UPSELL_COUNT – The total number of sales made through pitchplus upsell flows.
select	No	Return the specified data fields. You can pass multiple select parameters to select multiple values. If this parameter is absent, all values are returned. The valid values are: CHARGEBACK_AMOUNT – The amount of money returned through chargebacks. CHARGEBACK_COUNT – The total number of chargebacks. CHARGEBACK_RATE – The rate of chargebacks as a percentage of total sales. DIMENSION_VALUE – The dimension value. EARNINGS_PER_HOP – The average amount earned for each user who follows a hoplink. GROSS_SALE_AMOUNT – The total monetary amount of sales, including sales that have been refunded or charged back. GROSS_SALE_COUNT – The total number of sales, including sales that have been refunded or charged back. HOP_COUNT – The total number of users who have followed a hoplink connected to the specified account. HOPS_PER_SALE – The number of hops for each sale. HOPS_PER_ORDER_FORM_IMPRESSION – The number of hops for each viewing of the order form. NET_SALE_AMOUNT – The total monetary amount of sales, minus refunds and chargebacks. NET_SALE_COUNT – The total number of sales, minus refunds and chargebacks. ORDER_FORM_SALE_CONVERSION – The conversion rate between order form impressions and sales. ORDER_IMPRESSION – The number of times your order form has been served to potential customers. ORDER_SUBMISSION – The number of times your order form has been submitted by a customer, regardless of result. REBILL_AMOUNT – The total monetary amount of rebill payments made to you. REBILL_COUNT – The total number of rebill payments made to you. REFUND_AMOUNT – The amount of money returned through refunds. REFUND_COUNT – The total number of refunds. REFUND_RATE – The rate of refunds as a percentage of total sales. SALE_AMOUNT – The total monetary amount of initial sales, including one-time products and the initial purchases of recurring products. SALE_COUNT – The total number of initial sales, including one-time products and the initial purchases of recurring products. UPSELL_AMOUNT – The total monetary amount earned through pitchplus upsell flows. UPSELL_COUNT – The total number of sales made through pitchplus upsell flows.
sortAscending	No	If you are using the orderBy parameter, you can specify this parameter with a value of true to sort ascending instead of descending.
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 the previous day. Refunds are included or excluded based on the date of the initial purchase transaction.

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Analytics Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/{dimension}/summary

This method returns summary statistical data for a given role and dimension.

Valid roles include:

• AFFILIATE
• VENDOR

Dimensions include:

• AFFILIATE
• VENDOR_CATEGORY
• CUSTOMER_CURRENCY
• CUSTOMER_COUNTRY
• CUSTOMER_PROVINCE
• CUSTOMER_LANGUAGE
• PRODUCT_SKU – This dimension can only be used with the vendor role.
• TRACKING_ID
• VENDOR
• VENDOR_PRODUCT_SKU – This dimension can only be used with the affiliate role.

Head Parameters

Name	Required	Description
page	No	Return the specified page of results. The default is page 1.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
summaryType	Yes	This parameter specifies which type of summary data is desired. The valid values are: VENDOR_ONLY – this shows summary information for only the selected account AFFILIATE_ONLY – this shows summary information which excludes the selected account
dimensionFilter	No	This parameter limits the results returned to ones with a matching dimension id. This value is case sensitive.
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. Refunds are included or excluded based on the date of the initial purchase transaction.
orderBy	No	Order the results by the specified data field. The valid values are: CHARGEBACK_AMOUNT – The amount of money returned through chargebacks. CHARGEBACK_COUNT – The total number of chargebacks. CHARGEBACK_RATE – The rate of chargebacks as a percentage of total sales. DIMENSION_VALUE – The dimension value. EARNINGS_PER_HOP – The average amount earned for each user who follows a hoplink. GROSS_SALE_AMOUNT – The total monetary amount of sales, including sales that have been refunded or charged back. GROSS_SALE_COUNT – The total number of sales, including sales that have been refunded or charged back. HOP_COUNT – The total number of users who have followed a hoplink connected to the specified account. HOPS_PER_SALE – The number of hops for each sale. HOPS_PER_ORDER_FORM_IMPRESSION – The number of hops for each viewing of the order form. NET_SALE_AMOUNT – The total monetary amount of sales, minus refunds and chargebacks. NET_SALE_COUNT – The total number of sales, minus refunds and chargebacks. ORDER_FORM_SALE_CONVERSION – The conversion rate between order form impressions and sales. ORDER_IMPRESSION – The number of times your order form has been served to potential customers. ORDER_SUBMISSION – The number of times your order form has been submitted by a customer, regardless of result. REBILL_AMOUNT – The total monetary amount of rebill payments made to you. REBILL_COUNT – The total number of rebill payments made to you. REFUND_AMOUNT – The amount of money returned through refunds. REFUND_COUNT – The total number of refunds. REFUND_RATE – The rate of refunds as a percentage of total sales. SALE_AMOUNT – The total monetary amount of initial sales, including one-time products and the initial purchases of recurring products. SALE_COUNT – The total number of initial sales, including one-time products and the initial purchases of recurring products. UPSELL_AMOUNT – The total monetary amount earned through pitchplus upsell flows. UPSELL_COUNT – The total number of sales made through pitchplus upsell flows.
select	No	Return the specified data fields. You can pass multiple select parameters to select multiple values. If this parameter is absent, all values are returned. The valid values are: CHARGEBACK_AMOUNT – The amount of money returned through chargebacks. CHARGEBACK_COUNT – The total number of chargebacks. CHARGEBACK_RATE – The rate of chargebacks as a percentage of total sales. DIMENSION_VALUE – The dimension value. EARNINGS_PER_HOP – The average amount earned for each user who follows a hoplink. GROSS_SALE_AMOUNT – The total monetary amount of sales, including sales that have been refunded or charged back. GROSS_SALE_COUNT – The total number of sales, including sales that have been refunded or charged back. HOP_COUNT – The total number of users who have followed a hoplink connected to the specified account. HOPS_PER_SALE – The number of hops for each sale. HOPS_PER_ORDER_FORM_IMPRESSION – The number of hops for each viewing of the order form. NET_SALE_AMOUNT – The total monetary amount of sales, minus refunds and chargebacks. NET_SALE_COUNT – The total number of sales, minus refunds and chargebacks. ORDER_FORM_SALE_CONVERSION – The conversion rate between order form impressions and sales. ORDER_IMPRESSION – The number of times your order form has been served to potential customers. ORDER_SUBMISSION – The number of times your order form has been submitted by a customer, regardless of result. REBILL_AMOUNT – The total monetary amount of rebill payments made to you. REBILL_COUNT – The total number of rebill payments made to you. REFUND_AMOUNT – The amount of money returned through refunds. REFUND_COUNT – The total number of refunds. REFUND_RATE – The rate of refunds as a percentage of total sales. SALE_AMOUNT – The total monetary amount of initial sales, including one-time products and the initial purchases of recurring products. SALE_COUNT – The total number of initial sales, including one-time products and the initial purchases of recurring products. UPSELL_AMOUNT – The total monetary amount earned through pitchplus upsell flows. UPSELL_COUNT – The total number of sales made through pitchplus upsell flows.
sortAscending	No	If you are using the orderBy parameter, you can specify this parameter with a value of true to sort ascending instead of descending.
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 the previous day. Refunds are included or excluded based on the date of the initial purchase transaction.

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Analytics Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details

This method returns subscription data for a given role.

Valid roles include:

• AFFILIATE
• VENDOR

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/canceldate

This method returns a list of subscriptions where the subscription canceled date is within the specified date range.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
endDate	Yes	Return results ending with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
startDate	Yes	Return results beginning with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending.

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/cancelsixty

This method returns a list of subscriptions canceled in the last 60 days.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/cancelthirty

This method returns a list of subscriptions canceled in the last 30 days.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/compsixty

This method returns a list of subscriptions that will complete in the next 60 days.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/compthirty

This method returns a list of subscriptions that will complete within the next thirty days.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/nextpmtdate

This method returns a list of subscriptions where the next payment date is within the specified timeframe.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
endDate	Yes	Return results ending with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
startDate	Yes	Return results beginning with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/startdate

This method returns a list of subscriptions where the subscription start date is within the specified timeframe.

Head Parameters

Name	Required	Description
page	No	Return the specified page of results. The default is page 1.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
endDate	Yes	Return results ending with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
startDate	Yes	Return results beginning with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/details/status

This method returns subscription status data for a given role.

Valid roles include:

• AFFILIATE
• VENDOR

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
status	Yes	The subscription status. Valid values include: ACTIVE – The subscription is ongoing. COMPLETED – The final payment for the subscription has been made. CANCELED – The customer has canceled the subscription. RETRY_PAYMENT – A payment error has occurred, and the recurring payment is being retried. REQUEST_NEW_CARD – New payment information is required.
orderBy	No	Order the results by the specified data field. The valid values are: AFFILIATE_NICK_NAME – The nickname of the affiliate associated with the subscription. This value can only be used by vendors. CHARGEBACK_COUNT – The number of chargebacks made against the subscription. CHARGEBACK_AMOUNT – The amount of any chargebacks for the subscription to date, in US Dollars. CUSTOMER_FIRST_NAME – The customer's first name. This value can only be used by vendors. CUSTOMER_LAST_NAME – The customer's last name. This value can only be used by vendors. CUSTOMER_DISPLAY_NAME – The display name used by the customer. This value can only be used by vendors. CUSTOMER_EMAIL – The customer's email address. This value can only be used by vendors. DURATION – The length of time the subscription has been active. FUTURE_PAYMENTS_COUNT – The number of payments that will be processed as part of the subscription if no changes are made. INITIAL_SALE_AMOUNT – The amount of the initial sale, in US Dollars. INITIAL_SALE_COUNT – The number of initial sales made. ITEM_NUMBER – The item number for the recurring product in the subscription. NEXT_PAYMENT_DATE – The date on which the next payment for a recurring product is due. PROCESSED_PAYMENTS_COUNT – The number of payments processed as part of the subscription to date. PUB_NICK_NAME – The nickname of the vendor who published the subscription. This value can only be used by affiliates. PURCHASE_DATE – The date of purchase. REBILL_SALE_AMOUNT – The amount of each rebill payment, in US Dollars. REBILL_SALE_COUNT – The number of rebill payments made to date. RECEIPT – The receipt number. REFUND_COUNT – The number of refund requests made for the subscription. REFUND_AMOUNT – The amount of any refunds for the subscription to date, in US Dollars. STATUS – The subscription's current status. SUB_CANCEL_DATE – The date on which a subscription was canceled. SUB_END_DATE – The date on which a subscription will end. SUB_VALUE – The total value of the subscription to date.
sortDirection	No	Specify the order in which the sorted results are returned. The valid values are: ASC – Ascending. This is the default. DESC – Descending

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Detail Result

Supported Output Types

• application/xml
• application/json

GET  /1.3/analytics/{role}/subscription/trends

This method returns statistical summations of data for subscriptions over a specified time frame.

Valid roles include:

• AFFILIATE
• VENDOR

Head Parameters

Name	Required	Description
page	No	Return the specified page of results. The default is page 1.

Request Parameters

Name	Required	Description
account	Yes	Return results from the specified account nickname.
endDate	Yes	Return results ending with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
startDate	Yes	Return results beginning with the specified date. The date range is inclusive. The date format is yyyy-mm-dd.
groupBy	No	You can group the results by business date by passing DATE as the value.
productId	No	Return results on the specified Product ID. You can include multiple parameter/value pairs to return results on multiple Product IDs.

Required Keys and Roles

• Developer Key
• Clerk Key
  • Analytics Role

Return Type

Subscription Trends Data

Supported Output Types

• application/xml
• application/json

Return Types

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

The following return types are used:

• Analytics Result
• Analytics Status
• Subscription Detail Result
• Subscription Detail Result Row
• Subscription Trends Data

Analytics Result

Analytics Result 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="analyticsResult" type="analyticsResult"/>
<xs:complexType name="analyticsResult">
<xs:sequence>
<xs:element name="rows" type="rows" minOccurs="0"/>
<xs:element name="totals" type="totals" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="rows">
<xs:sequence>
<xs:element name="row" type="analyticsResultRow" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="analyticsResultRow">
<xs:sequence>
<xs:element name="dimensionIdentifier" type="xs:string" minOccurs="0"/>
<xs:element name="dimensionValue" type="xs:string" minOccurs="0"/>
<xs:element name="accountNickName" type="xs:string" minOccurs="0"/>
<xs:element name="data" type="analyticsValue" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="analyticsValue">
<xs:sequence>
<xs:element name="attribute" type="analyticAttribute" minOccurs="0"/>
<xs:element name="value" type="xs:anyType" nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="totals">
<xs:sequence>
<xs:element name="total" type="analyticsValue" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="analyticAttribute">
<xs:restriction base="xs:string">
<xs:enumeration value="DIMENSION_VALUE"/>
<xs:enumeration value="HOP_COUNT"/>
<xs:enumeration value="ORDER_IMPRESSION"/>
<xs:enumeration value="ORDER_SUBMISSION"/>
<xs:enumeration value="SALE_COUNT"/>
<xs:enumeration value="SALE_AMOUNT"/>
<xs:enumeration value="REFUND_COUNT"/>
<xs:enumeration value="REFUND_AMOUNT"/>
<xs:enumeration value="CHARGEBACK_COUNT"/>
<xs:enumeration value="CHARGEBACK_AMOUNT"/>
<xs:enumeration value="REBILL_COUNT"/>
<xs:enumeration value="REBILL_AMOUNT"/>
<xs:enumeration value="UPSELL_COUNT"/>
<xs:enumeration value="UPSELL_AMOUNT"/>
<xs:enumeration value="GROSS_SALE_COUNT"/>
<xs:enumeration value="GROSS_SALE_AMOUNT"/>
<xs:enumeration value="NET_SALE_COUNT"/>
<xs:enumeration value="NET_SALE_AMOUNT"/>
<xs:enumeration value="EARNINGS_PER_HOP"/>
<xs:enumeration value="HOPS_PER_SALE"/>
<xs:enumeration value="HOPS_PER_ORDER_FORM_IMPRESSION"/>
<xs:enumeration value="ORDER_FORM_SALE_CONVERSION"/>
<xs:enumeration value="REFUND_RATE"/>
<xs:enumeration value="CHARGEBACK_RATE"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>

Analytics Status

Analytics Status 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="AnalyticsStatus" type="AnalyticsStatus"/>
<xs:complexType name="AnalyticsStatus">
<xs:sequence>
<xs:element name="status" type="xs:string"/>
<xs:element name="lastUpdateTime" type="xs:dateTime"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

Subscription Detail Result

Subscription Detail Result 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="subscriptionDetailResult" type="subscriptionDetailResult"/>
<xs:complexType name="subscriptionDetailResult">
<xs:sequence>
<xs:element name="totalCount" type="xs:int"/>
<xs:element name="data" type="subscriptionDetailsDataWrapper" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="subscriptionDetailsDataWrapper">
<xs:sequence>
<xs:element name="row" type="subscriptionDetailsRowData" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="subscriptionDetailsRowData">
<xs:sequence>
<xs:element name="affNickName" type="xs:string" minOccurs="0"/>
<xs:element name="cancelled" type="xs:boolean"/>
<xs:element name="chargebackAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="chargebackCount" type="xs:int"/>
<xs:element name="countryCode" type="xs:string" minOccurs="0"/>
<xs:element name="currencyCode" type="xs:string" minOccurs="0"/>
<xs:element name="customerDisplayName" type="xs:string" minOccurs="0"/>
<xs:element name="customerFirstName" type="xs:string" minOccurs="0"/>
<xs:element name="customerLastName" type="xs:string" minOccurs="0"/>
<xs:element name="duration" type="xs:int"/>
<xs:element name="email" type="xs:string" minOccurs="0"/>
<xs:element name="frequency" type="xs:string" minOccurs="0"/>
<xs:element name="ftxnId" type="xs:int"/>
<xs:element name="futurePaymentsCount" type="xs:int"/>
<xs:element name="initialSaleAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="initialSaleCount" type="xs:int"/>
<xs:element name="itemNo" type="xs:string" minOccurs="0"/>
<xs:element name="nextPaymentDate" type="xs:dateTime" nillable="true" minOccurs="0"/>
<xs:element name="paymentMethod" type="xs:string" minOccurs="0"/>
<xs:element name="processedPaymentsCount" type="xs:int"/>
<xs:element name="province" type="xs:string" minOccurs="0"/>
<xs:element name="pubNickName" type="xs:string" minOccurs="0"/>
<xs:element name="purchaseDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="rebillSaleAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="rebillSaleCount" type="xs:int"/>
<xs:element name="receipt" type="xs:string" minOccurs="0"/>
<xs:element name="refundAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="refundCount" type="xs:int"/>
<xs:element name="status" type="xs:string" minOccurs="0"/>
<xs:element name="subCancelDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="subEndDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="subValue" type="xs:decimal" minOccurs="0"/>
<xs:element name="timeStr" type="xs:string" minOccurs="0"/>
<xs:element name="trialPeriod" type="xs:string" minOccurs="0"/>
<xs:element name="txnType" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

Subscription Detail Result Row

Subscription Detail Result Row 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:complexType name="subscriptionDetailsRowData">
<xs:sequence>
<xs:element name="affNickName" type="xs:string" minOccurs="0"/>
<xs:element name="cancelled" type="xs:boolean"/>
<xs:element name="chargebackAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="chargebackCount" type="xs:int"/>
<xs:element name="countryCode" type="xs:string" minOccurs="0"/>
<xs:element name="currencyCode" type="xs:string" minOccurs="0"/>
<xs:element name="customerDisplayName" type="xs:string" minOccurs="0"/>
<xs:element name="customerFirstName" type="xs:string" minOccurs="0"/>
<xs:element name="customerLastName" type="xs:string" minOccurs="0"/>
<xs:element name="duration" type="xs:int"/>
<xs:element name="email" type="xs:string" minOccurs="0"/>
<xs:element name="frequency" type="xs:string" minOccurs="0"/>
<xs:element name="ftxnId" type="xs:int"/>
<xs:element name="futurePaymentsCount" type="xs:int"/>
<xs:element name="initialSaleAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="initialSaleCount" type="xs:int"/>
<xs:element name="itemNo" type="xs:string" minOccurs="0"/>
<xs:element name="nextPaymentDate" type="xs:dateTime" nillable="true" minOccurs="0"/>
<xs:element name="paymentMethod" type="xs:string" minOccurs="0"/>
<xs:element name="processedPaymentsCount" type="xs:int"/>
<xs:element name="province" type="xs:string" minOccurs="0"/>
<xs:element name="pubNickName" type="xs:string" minOccurs="0"/>
<xs:element name="purchaseDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="rebillSaleAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="rebillSaleCount" type="xs:int"/>
<xs:element name="receipt" type="xs:string" minOccurs="0"/>
<xs:element name="refundAmount" type="xs:decimal" minOccurs="0"/>
<xs:element name="refundCount" type="xs:int"/>
<xs:element name="status" type="xs:string" minOccurs="0"/>
<xs:element name="subCancelDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="subEndDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="subValue" type="xs:decimal" minOccurs="0"/>
<xs:element name="timeStr" type="xs:string" minOccurs="0"/>
<xs:element name="trialPeriod" type="xs:string" minOccurs="0"/>
<xs:element name="txnType" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

Subscription Trends Data

Subscription Trend 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="SubscriptionTrendsData" type="SubscriptionTrendsData"/>
<xs:complexType name="SubscriptionTrendsData">
<xs:sequence>
<xs:element name="totalCount" type="xs:int"/>
<xs:element name="data" type="subscriptionTrendsDataWrapper" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="subscriptionTrendsDataWrapper">
<xs:sequence>
<xs:element name="row" type="subscriptionProductRowData" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="subscriptionProductRowData">
<xs:sequence>
<xs:element name="avgActiveSubCnt" type="xs:decimal" minOccurs="0"/>
<xs:element name="avgSubAge" type="xs:decimal" minOccurs="0"/>
<xs:element name="avgSubValue" type="xs:decimal" minOccurs="0"/>
<xs:element name="businessDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="cancelSubCnt" type="xs:decimal" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
<xs:element name="duration" type="xs:int"/>
<xs:element name="frequency" type="xs:string" minOccurs="0"/>
<xs:element name="grossSales" type="xs:decimal" minOccurs="0"/>
<xs:element name="initialSaleAmt" type="xs:decimal" minOccurs="0"/>
<xs:element name="initialSaleCnt" type="xs:decimal" minOccurs="0"/>
<xs:element name="itemNo" type="xs:string" minOccurs="0"/>
<xs:element name="netSales" type="xs:decimal" minOccurs="0"/>
<xs:element name="nickname" type="xs:string" minOccurs="0"/>
<xs:element name="productId" type="xs:int"/>
<xs:element name="recurringSaleAmt" type="xs:decimal" minOccurs="0"/>
<xs:element name="recurringSaleCnt" type="xs:decimal" minOccurs="0"/>
<xs:element name="title" type="xs:string" minOccurs="0"/>
<xs:element name="totalSalesCnt" type="xs:decimal" minOccurs="0"/>
<xs:element name="trialPeriod" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

Usage Information

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

Related Articles

• Analytics Reporting – This article explains how to use ClickBank's in-UI analytics tools. 

ClickBank APIs

 The ClickBank Application Program Interfaces, or APIs, are tools that let you create applications to get information on your account. Your application provides your credentials and the information request, and ClickBank returns the information in the specified format.

Using information from the ClickBank APIs, you can create an application that displays or uses this data in useful ways. For example, you could create a dashboard that shows ClickBank data in addition to data from accounts with other online services, a subscription management tool, or an analytics package that shows sales trends for an account or product. 

Before proceeding with API use, make sure you review and agree to the ClickBank API Contract. 

ClickTip: API users must be familiar with REST APIs in order to create their own application using the ClickBank APIs. If you do not have this skill set, we recommend finding a developer who can assist you.

 

Supported APIs 

ClickBank supports the following APIs in version 1.3--which is the current version. There are legacy versions available, but we recommend migrating to the new version.  

Analytics API

The Analytics API provides subscription and statistical information. 

• Article – Analytics API
  
• URL – https://api.clickbank.com/rest/1.3/analytics
  
  

Images API

The Images API lists images associated with an account.

• Article – Images API
• URL – https://api.clickbank.com/rest/1.3/images
  
  

Orders API

The Orders API lets you view order information and update some order parameters.

• Article – Orders API
• URL – https://api.clickbank.com/rest/1.3/orders2
  
  

Products API

The Products API lets you perform CRUD product management operations.

• Article – Products API
• URL – https://api.clickbank.com/rest/1.3/products
  
  

Quickstats API

The Quickstats API provides information about your account.

• Article – Quickstats API
• URL – https://api.clickbank.com/rest/1.3/quickstats

Shipping API

The Shipping API provides shipping information for physical good orders by receipt or time parameters.

• Article – Shipping API
• URL – https://api.clickbank.com/rest/1.3/shipping2

Ship Notice API

The Ship Notice API lets you create shipping notifications.

• Article – Ship Notice API
• URL – https://api.clickbank.com/rest/1.3/shipping2/shipnotice

Tickets API

The Tickets API lets you create a technical support or refund ticket, and view or update the status of an existing ticket. For refund tickets related to physical products, you can also confirm that you’ve received a returned product.

• Article – Tickets API
• URL – https://api.clickbank.com/rest/1.3/tickets

Legacy Versions

These are older versions of the 1.3 APIs. They lack some of the new features of the versions listed above. You can continue to use them if you are already doing so, but you should plan on migrating to the newer versions, as these versions will eventually be deprecated.

• Legacy Orders API – https://api.clickbank.com/rest/1.3/orders
• Legacy Shipping API – https://api.clickbank.com/rest/1.3/shipping
• Legacy Ship Notice API – https://api.clickbank.com/rest/1.3/shipping/shipnotice

ATTENTION CLICKBANK VENDORS AND AFFILIATES

 Important! To comply with an order issued by the U.S. District Court for the District of Utah, if you send unsolicited email marketing campaigns promoting products sold through ClickBank, you must not send unsolicited marketing emails to the domains owned and/or operated by XMission LC listed on the linked suppression list. Sending unsolicited marketing emails to the domains on the linked suppression list may be considered a violation of the CAN-SPAM Act and, therefore, a breach of your obligations under Section 6 of the Client Contract, and could expose you or ClickBank to court action, including potential monetary penalties, and immediate termination of your ClickBank account. This requirement does not prohibit you from responding to potential customer inquiries, sending order confirmations or tracking information or responding to customer service requests.

Product Categories

ClickBank is a global leader in online retail of digital and physical products, with more than 200 million customers and distribution in over 200 countries. Join millions of satisfied buyers that have purchased products from ClickBank. We have the digital and physical products you are looking for with an exceptional money-back guarantee. Browse the categories to find the perfect product for you.

ClickBank is a Leading Global Retailer and Affiliate Marketplace

ClickBank is a leading global retailer with its own affiliate marketplace. We enable you to grow with unlimited scale. Sell Grow your sales with the ClickBank Affiliate Marketplace. Shop Discover and shop for innovative products. Promote Find top-performing products to promote. Learn Learn how to make money online with courses in performance marketing.