Histograms

Histograms are for particular kinds of reports with cohorts and periods.

Get Transaction histogram report data

Get Transaction histogram report data.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string <date-time>

Report start day.

periodEnd
required
string <date-time>

Report end day.

aggregationField
required
string

Report aggregation field.

Enum: "website" "currency" "bin" "rebillNumber" "transactionResult" "transactionType" "gatewayAccount" "leadsAffiliate" "leadsCampaign" "leadsContent" … 5 more
aggregationPeriod
required
string

Report aggregation period.

Enum: "hour" "day" "month"
metric
required
string

Report metric.

Enum: "ApprovalThroughput" "AuthApprovalThroughput" "AvgSalesPrice" "Refunds" "RefundCount" "Sales" "SalesCount" "UnapprovedCount"
filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

Responses
200

Transaction report was retrieved successfully.

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

Entry date-time.

value
number

Entry value.

403

Access forbidden.

get/histograms/transactions
Request samples
const params = {
    periodStart: '2017-09-21T00:00:00Z',
    // seven day period
    periodEnd: '2017-09-28T23:59:59Z',
    aggregationField: 'website',
    aggregationPeriod: 'day',
    metric: 'approval'
};
const report = await api.histograms.getTransactionHistogramReport(params);
console.log(report.fields.data);
Response samples
application/json
{
  • "data": [
    ]
}