Button helps Publishers and Merchants build partnerships to earn revenue and acquire users through a mobile marketplace.
The data from Button is centered around transactions. Funnel downloads all transactions based on their creation date in Button*.
In addition to the basic transaction data, each transaction has one or more line items with detailed data about the items in the transaction. Here's how the data is structured conceptually:
See a list of the dimensions and metrics you can get from Button below.
* The Button API currently does not have the capability of querying transactions based on purchase date.
Available to all metrics
Button tracking token (btn_ref)
Button tracking token associated with this transaction
The ID of the button.
Button order ID
Button generated Order ID that is globally unique. Only available for new-user-order and existing-user-order events.
A Button configuration value distinguishing the Merchant Campaign ID tied to this transaction.
The type of event that generated this commission.
The Button organization ID for the Merchant that received the billable transaction.
Commerce organization name
The Button organization name for the Merchant that received the billable transaction.
Order click channel
The channel in which the user completed the transaction. Values include: App, Webview, unknown.
Merchant reported ID in their own namespace. Only available for new-user-order and existing-user-order events and when reported by the merchant.
Publisher token set (pub_ref)
The publisher token set when a Button or Link was fetched (only visible to the Publisher).
Publisher customer ID
The publisher's internal customer ID (only available for the publisher organization, and only if it is configured)
The Button organization ID for the Publisher application that drove the transaction.
Publisher organization name
The Button organization name for the Publisher application that drove the transaction.
The current state of the transaction (pending, validated or declined)
Basic metrics for the transaction. Not available on line item level.
The commission your organization is owed (originally provided as negative 'Amount' in button)
The commission your organization has earned (originally provided as positive 'Amount' in button).
The total value of the order. Includes total value of all items purchased, whether or not they qualified for a commission. Includes discounts, if applied. Only available for new-user-order and existing-user-order events.
Line item dimensions
Only available for line item metrics.
Line item identifier
A unique identifier for this line item, within the scope of this order.
Line item description
Text describing the line item.
Line item metrics
Line item total
The total price of all items bought in a particular line item (e.g. if 3 bananas were purchased for $3.00 each, total would be $9.00)
Line item amount
The line item value for a single item
Line item quantity
The number of individual units purchased.
Line item publisher commission
The total commission generated by the line item. A publisher_commission equal to 0 means no commission was earned for this line item. This field will only appear on transactions where created_date is after 2018-07-18T23:00:00Z