/
Retrieve a time series tr...

Retrieve a time series transactions report
Experimental

Request

Retrieves a transactions report that is aggregated by time periods.

Security
SecretApiKey or JWT
Query
typestring

Type of report aggregation.

Default:"count"
Enum:"count""amount""approval-rate""incomplete-rate"
subaggregatestring

Report subaggregate.

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 ]

Limits the number of collection items to be returned.

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=1000&offset=1000' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Headers
Pagination-Totalinteger

Total number of items.

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": [
    { … }
  ]
}