Retrieve a time series transactions report

Retrieves a transactions report that is aggregated by time periods.

SecuritySecretApiKey or JWT
Request
query Parameters
type
required
string

Type of report aggregation.

Enum: "count" "amount" "approval-rate" "incomplete-rate"
subaggregate
required
string

Report subaggregate.

Enum: "website" "gateway-account" "currency" "plan" "leads.source" "leads.medium" "leads.campaign" "leads.content" "leads.term" "leads.affiliate" … 2 more
periodStart
required
string <date-time>

Date and time when the report starts.

periodEnd
required
string <date-time>

Date and time when the report ends.

Responses
200

Report retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

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
Response Schema: application/json
Array of objects

Time series data.

Array
date
string

Date in YYYY-MM-DD format .

total
number <double>

Total number of all transactions within the aggregation.

object

Subaggregates that have transactions within the range.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/experimental/reports/time-series-transaction
Request samples
const params = {
    periodStart: '2017-08-29T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    type: 'count',
    subaggregate: 'gateway-account',
    limit: 20,
    offset: 0
};
const report = await api.reports.getTimeSeriesTransaction(params);
Response samples
application/json
{
  • "data": [
    ]
}