List Transactions (single currency)

get https://api.usebutton.com/v1/affiliation/accounts/{account_id}/transactions

Retrieve a list of transactions within a billing account (currency).

A transaction is a record of a commission owed or earned. A transaction is created when a user moves from a Publisher to a Brand and takes an action like installing the app or making a purchase (API details for a Brand to report an order). A finalized transaction initiates a credit to the Publisher for driving the user's transaction or app installation, and a debit to the Brand as they received an order or an app installation. We capture the various transaction event types in the category field. Additionally, transactions have a status associated with them so that you can identify the current state of the life-cycle the transaction is in.

For a full breakdown of the fields included in the Transaction payload to the right, check out the Transaction event object.

If you want to paginate across your transactions, utilize the meta.next URL as your next request URL until it is null.

Path Params

account_id

string

required

The specific account to query.

Query Params

cursor

string

Defaults to optional

An opaque string that lets you view a consistent list of transactions.

start

string

Filter transactions created at or after this time. Time is in RFC 3339 format. Example: 2015-11-18T00:00:00Z

end

string

Filter transactions created before this time. Time is in RFC 3339 format. Example: 2015-11-18T00:00:00Z

time_field

string

Defaults to optional

Time field to filter by. Accepted values are created_date, modified_date, and attribution_date. When not specified, created_date is used as default.

page_size

int32

Number of transaction to retrieve in each request. When not specified, 50 is used as default.

country

string

Defaults to optional

Filter transactions by country. Country is in ISO 3166 Alpha-2 format (case-insensitive). Example: us

Response

Language

Credentials

Basic

base64

Request


xxxxxxxxxx
1
# without optional arguments
2
curl https://api.usebutton.com/v1/affiliation/accounts/acc-XXX/transactions?start=2019-01-01T00%3A00%3A00Z&end=2019-01-05T00%3A00%3A00Z \
3
  -X GET \
4
  -u YOUR_API_KEY:
5
6
# with optional arguments
7
curl https://api.usebutton.com/v1/affiliation/accounts/acc-XXX/transactions?start=2019-01-01T00%3A00%3A00Z&end=2019-01-05T00%3A00%3A00Z&cursor=cXw&time_field=modified_date \
8
  -X GET \
9
  -u YOUR_API_KEY:

Choose an example:

application/json

200200