Retrieve a time series transactions report
Experimental

Request

Retrieves a report of sale and capture transactions, with one row for each day of the period. Each row holds an aggregation of every transaction of the day, and a breakdown of that day by the subaggregate field. Transactions occur on the day of the processedTime value.

Security
SecretApiKey or JWT
Query
typestring
Aggregate the transactions of each day by count, sum of amounts, approval rate, or incomplete rate.
Default:"count"
Enum:"count""amount""approval-rate""incomplete-rate"
subaggregatestring
Group the transactions of each day by this field, one subaggregate for each value.
Default:"gateway-account"
Enum:"website""gateway-account""currency""plan""leads.source""leads.medium""leads.campaign""leads.content""leads.term""leads.affiliate"
periodStartstring, (date-time)
Date and time when the report starts. If no value is provided, the report begins on the first day of the current month.
periodEndstring, (date-time)
Date and time when the report ends. If no value is provided, the report ends on the last day of the current month.
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]
Specifies the starting point within the collection of items to be returned.
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/time-series-transaction?type=count&subaggregate=website&periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.
Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger
Maximum number of items per page.
Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
dataArray of objects
Time series data.
Response
{
  "data": [
    { … }
  ]
}