Analytics Service Description

The following methods are available at the servlet path /rest/1.3/analytics
GET  /1.3/analytics/status

Return the status & last update time of the API.

The possible statuses are:

  • GREEN (normal operation)
  • YELLOW (delayed data)
  • RED (severely delayed data or critical problem)

Return Type: An AnalyticsStatus

Supported Output Types : application/xml, application/json, text/csv

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/details/cancelsixty
Returns a list of subscriptions canceled in the last 60 days.

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/details/startdate
Returns a list of subscriptions where the subscription start date is between (inclusive) the startDate and endDate parameters.

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)
startDatetrueThe earliest subscription start date the result list will contain. Date Format: yyyy-MM-dd
endDatetrueThe latest subscription start date the result list will contain. Date Format: yyyy-MM-dd

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/details/canceldate
Returns a list of subscriptions where the subscription canceled date is between (inclusive) the startDate and endDate parameters.

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)
startDatetrueThe earliest subscription cancellation date the result list will contain. Date Format: yyyy-MM-dd
endDatetrueThe latest subscription cancellation date the result list will contain. Date Format: yyyy-MM-dd

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/details/nextpmtdate
Returns a list of subscriptions where the next payment date is between (inclusive) the startDate and endDate parameters.

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)
startDatetrueThe earliest next subscription payment date the result list will contain. Date Format: yyyy-MM-dd
endDatetrueThe latest next subscription payment date the result list will contain. Date Format: yyyy-MM-dd

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/details/compthirty
Returns a list of subscriptions completing in the next 30 days.

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/details/compsixty
Returns a list of subscriptions completing in the next 60 days.

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/details/cancelthirty
Returns a list of subscriptions canceled in the last 30 days.

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

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

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)
statustrueThe subscription status. Valid values include:
  • ACTIVE
  • COMPLETED
  • CANCELED
  • RETRY_PAYMENT
  • REQUEST_NEW_CARD

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

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

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
orderByfalseSee compthirty orderBy
sortDirectionfalseThe order in which the sorted results are returned:
  • ASC (ascending - default)
  • DESC (descending)

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/subscription/trends
Returns statistical summations of data for subscriptions

Valid roles include:
  • AFFILIATE
  • VENDOR

Head Parameters :

NameRequiredDescription
PagefalseThe page number of the results (default is page 1)

Request Parameters :

NameRequiredDescription
accounttrueThe account nickname
groupByfalseYou may group by business date by passing DATE as the value
productIdfalseThe product id to report on, multiple parameter/value pairs may be passed
startDatetrueThe start date (inclusive) of the time frame to report on - format is yyyy-MM-dd.
endDatetrueThe end date (inclusive) of the time frame to report on - format is yyyy-MM-dd.

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/schema/AnalyticsStatus
Returns the XML Schema that describes the format of the retrieved data when an analytics status API call is made.

Return Type: XML Schema of AnalyticsStatus object.

Supported Output Types : application/xml

GET  /1.3/analytics/schema/SubscriptionDetailResult
Returns the XML Schema that describes the format of the retrieved data for subscriptions

Return Type: XML Schema of SubscriptionDetailResult object.

Supported Output Types : application/xml

GET  /1.3/analytics/schema/SubscriptionDetailResultRow
Returns the XML Schema that describes the format of the retrieved data for individual subscriptions

Return Type: XML Schema of SubscriptionDetailResultRow object.

Supported Output Types : application/xml

GET  /1.3/analytics/schema/SubscriptionTrendsData
Returns the XML Schema that describes the format of the retrieved data for subscription trends

Return Type: XML Schema of SubscriptionTrendsData object.

Supported Output Types : application/xml

GET  /1.3/analytics/{role}/{dimension}
Returns statistical data for a given role and dimension. Valid roles include:
  • AFFILIATE
  • VENDOR
Dimensions include:
  • AFFILIATE
  • CATEGORY
  • CURRENCY
  • CUSTOMER_COUNTRY
  • CUSTOMER_PROVINCE
  • LANGUAGE
  • PRODUCT_SKU – Only available if role = VENDOR
  • TRACKING_ID
  • VENDOR
  • VENDOR_PRODUCT_SKU – Only available if role = AFFILIATE

Return Type: An AnalyticsResult

Head Parameters :

NameRequiredDescription
PagefalseThe page number of the results (default is page 1)

Request Parameters :

NameRequiredDescription
accounttrueAccount to query for.
startDatefalseThe start date of the time frame to report on - format is yyyy-MM-dd. Defaults to the previous day.
endDatefalseThe end date of the time frame to report on - format is yyyy-MM-dd. Defaults to the current day.
dimensionFilterfalseThis parameter limits the results returned to ones with a matching dimension id. This value is case sensitive.
selectfalseThis optional parameter specifies the data fields to return. Multiple select parameters may be passed to select multiple values. If this parameter is absent all values will be returned. The possible values for this parameter are:

  • CHARGEBACK_AMOUNT
  • CHARGEBACK_COUNT
  • CHARGEBACK_RATE
  • DIMENSION_VALUE
  • EARNINGS_PER_HOP
  • GROSS_SALE_COUNT
  • GROSS_SALE_AMOUNT
  • HOP_COUNT
  • HOPS_PER_SALE
  • HOPS_PER_ORDER_FORM_IMPRESSION
  • NET_SALE_AMOUNT
  • NET_SALE_COUNT
  • ORDER_FORM_SALE_CONVERSION
  • ORDER_IMPRESSION
  • ORDER_SUBMISSION
  • REBILL_AMOUNT
  • REBILL_COUNT
  • REFUND_AMOUNT
  • REFUND_COUNT
  • REFUND_RATE
  • SALE_AMOUNT
  • SALE_COUNT
  • UPSELL_AMOUNT
  • UPSELL_COUNT

orderByfalseThis optional parameter specifies which data field the results should be ordered by. The possible values are shown in the select values list above.
sortAscendingfalseWhen an order by is included this may be specified with a value of true to sort ascending instead of descending

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/{role}/{dimension}/summary
Returns summary statistical data for a given role, dimension, and summary type. Valid roles include:
  • AFFILIATE
  • VENDOR
Dimensions include:
  • AFFILIATE
  • CATEGORY
  • CURRENCY
  • CUSTOMER_COUNTRY
  • CUSTOMER_PROVINCE
  • LANGUAGE
  • PRODUCT_SKU – Only available if role = VENDOR
  • TRACKING_ID
  • VENDOR
  • VENDOR_PRODUCT_SKU – Only available if role = AFFILIATE

Return Type: An AnalyticsResult

Head Parameters :

NameRequiredDescription
PagefalseThe page number of the results (default is page 1)

Request Parameters :

NameRequiredDescription
accounttrueAccount to query for.
summaryTypetrueThis parameter specifies which type of summary data is desired. The possible values for this parameter are:
  • VENDOR_ONLY - this shows summary information for only the selected account
  • AFFILIATE_ONLY - this shows summary information which excludes the selected account
startDatefalseThe start date of the time frame to report on - format is yyyy-MM-dd. Defaults to the previous day.
endDatefalseThe end date of the time frame to report on - format is yyyy-MM-dd. Defaults to the current day.
dimensionFilterfalseThis parameter limits the results returned to ones with a matching dimension id. This value is case sensitive.
selectfalseThis optional parameter specifies the data fields to return. Multiple select parameters may be passed to select multiple values. If this parameter is absent all values will be returned. The possible values for this parameter are:

  • CHARGEBACK_AMOUNT
  • CHARGEBACK_COUNT
  • CHARGEBACK_RATE
  • DIMENSION_VALUE
  • EARNINGS_PER_HOP
  • GROSS_SALE_COUNT
  • GROSS_SALE_AMOUNT
  • HOP_COUNT
  • HOPS_PER_SALE
  • HOPS_PER_ORDER_FORM_IMPRESSION
  • NET_SALE_AMOUNT
  • NET_SALE_COUNT
  • ORDER_FORM_SALE_CONVERSION
  • ORDER_IMPRESSION
  • ORDER_SUBMISSION
  • REBILL_AMOUNT
  • REBILL_COUNT
  • REFUND_AMOUNT
  • REFUND_COUNT
  • REFUND_RATE
  • SALE_AMOUNT
  • SALE_COUNT
  • UPSELL_AMOUNT
  • UPSELL_COUNT

orderByfalseThis optional parameter specifies which data field the results should be ordered by. The possible values are shown in the select values list above.
sortAscendingfalseWhen an order by is included this may be specified with a value of true to sort ascending instead of descending

Supported Output Types : application/xml, application/json

Required Roles : api_analytics_client, HAS_DEVELOPER_KEY

GET  /1.3/analytics/schema/AnalyticsResult
Returns the XML Schema that describes the format of the retrieved data for analytics query API calls.

Return Type: XML Schema of AnalyticsResult object.

Supported Output Types : application/xml