Retrieve a time series transactions report

Retrieve a transactions report aggregated by time periods.

SecuritySecretApiKey or JWT
Request
query Parameters
type
required
string

Report aggregation type.

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

Report start date.

periodEnd
required
string

Report end date.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array of objects
Array
date
string

Date in format YYYY-MM-DD.

total
number <double>

Amount or count of all transactions within the aggregation.

object

Subaggregates which have appropriate transactions within the range.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/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": [
    ]
}