Reports

Retrieve summary information about your customers, subscriptions, transactions, and more.

Retrieve a API Log Summary Report

Retrieve a API Log Summary Report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

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

Route string pattern.

total
integer

Total count of requests.

get
integer

Count of GET requests.

post
integer

Count of POST requests.

put
integer

Count of PUT requests.

patch
integer

Count of PATCH requests.

delete
integer

Count of DELETE requests.

head
integer

Count of HEAD requests.

options
integer

Count of OPTIONS requests.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/api-log-summary
Request samples
const params = {
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getApiLogSummary(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a cumulative subscriptions report

Retrieve a cumulative subscriptions report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

Enum: "day" "month"
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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

Report was retrieved successfully.

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

Date in format YYYY-MM (monthly aggregation) or YYYY-MM-DD (daily aggregation).

newCount
integer

Number of new subscriptions within the aggregation.

canceledCount
integer

Number of canceled subscriptions within the aggregation.

cumulativeCount
integer

Number of cumulative subscriptions from the previous aggregation + number of new subscriptions - number of canceled subscriptions within the aggregation.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/cumulative-subscriptions
Request samples
const params = {
    aggregationField: 'day',
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getCumulativeSubscriptions(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve dashboard data

Retrieve dashboard data.

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

Report start day.

periodEnd
required
string <date-time>

Report end day.

metrics
string <date-time>

Comma-separated list of metrics.

segments
string

Dashboard report segments as a JSON array.

Responses
200

Report was retrieved successfully.

Response Schema: application/json
Array
metric
string

Metric type.

Enum: "approvalRate" "salesCount" "salesValue" "refundsValue" "chargebacksCount" "chargebacksValue" "transactionsCount" "redeemedCouponsCount" "newLeadsCount" "newCustomersCount" … 20 more
humanName
string

Metric name to display.

increaseIsGood
boolean

True when the higher value means a better performance thus positive for a merchant, false otherwise.

Array of objects
Array
name
string

Segment name.

value
number or null <double>

Segment value for the given date range.

previousValue
number or null <double>

Segment value for the previous date range (relative to the given date range).

humanValue
string or null

Human readable segment value (formatted with a currency sign).

changeRatio
number or null <double>

Ratio of current value per previous value null is infinity.

humanChangeRatio
string or null

Human readable change ratio (formatted percentage with a "%" sign), null is infinity.

Array of objects
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/dashboard
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/experimental/organizations/unknown/reports/dashboard?periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&metrics=2019-08-24T14%3A15%3A22Z&segments=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Retrieve a DCC markup report

Retrieve a DCC markup report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

Enum: "day" "month" "bin" "country" "baseCurrency" "quoteCurrency"
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Value by which the report provides aggregated data. The date values are displayed as following: Day: YYYY-MM-DD; Month: YYYY-MM.

selectedCount
integer

Number of selected offers in the aggregation.

selectedSum
number <double>

Amount of selected offers in the aggregation.

rejectedCount
integer

Number of rejected offers in the aggregation.

rejectedSum
number <double>

Amount of rejected offers in the aggregation.

unknownCount
integer

Number of offers in the aggregation which weren't selected nor rejected.

unknownSum
number <double>

Amount of offers in the aggregation which weren't selected nor rejected.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/dcc-markup
Request samples
const params = {
    aggregationField: 'day',
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    filter: `gatewayAccounts:f9b4fa10-df1d-48a3-85b3-ff6bd7ce0ed2; \
            transactionResult:approved,canceled,declined,unknown`,
    tz: 0
};
const report = await api.reports.getDccMarkup(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a disputes report

Retrieve a disputes report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report will be aggregated by this field.

Enum: "website" "gatewayAcquirer" "currency" "bin" "country" "rebillNumber" "retryNumber" "gatewayAccount" "transactionAmount"
periodMonth
required
string

Report month in format YYYY-MM.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Selected aggregation field value (defined by query). It can be, for example, website or country. You define it in aggregationField param in query.

countVisa
integer

Disputes count on Visa.

ratioCountVisa
number <double>

Disputes count / Settled transactions count.

ratioAmountVisa
number <double>

Disputes amount / Settled transactions amount.

countMastercard
integer

Disputes count on Mastercard.

ratioCountMastercard
number <double>

Disputes count / Settled transactions count.

ratioAmountMastercard
number <double>

Disputes amount / Settled transactions amount.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/disputes
Request samples
const params = {
    aggregationField: 'website',
    periodMonth: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getDisputes(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a events triggered summary report

Retrieve a events triggered summary report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

System event name.

Enum: "dispute-created" "gateway-account-requested" "transaction-processed" "subscription-canceled" "subscription-renewed" "payment-card-expired" "payment-declined" "transaction-process-requested" "risk-score-changed"
count
integer

Count of event triggered.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/events-triggered
Request samples
const params = {
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getEventsTriggeredSummary(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a rules matched summary report

Retrieve a rules matched summary report by events triggered.

SecuritySecretApiKey or JWT
Request
path Parameters
eventType
required
string (EventType)

The system event type.

Enum: "account-password-reset-requested" "account-verification-requested" "aml-list-possibly-matched" "application-instance-disabled" "application-instance-enabled" "balance-transaction-settled" "customer-created" "customer-one-time-password-requested" "dispute-created" "dispute-modified" … 52 more
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Rule matched name.

count
integer

Count of matched rule.

approvalRate
number <double>

Transaction approval rate by rule.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/events-triggered/{eventType}/rules
Request samples
const params = {
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getRulesMatchedSummary(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a future renewals report

Retrieve a future renewals report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date. It should be in the future.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Date in format YYYY-MM.

sum
number <double>

Amount of future renewals in user's reporting currency.

Array of objects
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/future-renewals
Request samples
const params = {
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getFutureRenewals(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a KYC acceptance summary report

Retrieve a KYC acceptance summary report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

Responses
200

Report was retrieved successfully.

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

Type of KYC document.

Enum: "identity-proof" "address-proof" "funds-proof" "purchase-proof" "credit-file-proof"
object

Statistics for each status.

total
integer

Total documents amount.

accuracyRate
number

Percent of automatically accepted and rejected documents that remain in the same status after review. Calculated by the formula: (nonarchived total - accepted auto rejected - rejected auto accepted)/nonarchived total.

acceptanceRate
number

Percent of accepted documents out of the total number of KYC documents. Calculated by accepted total divided by the total of nonarchived documents.

manualReviewTime
number

Median duration in minutes between review and created time for manually reviewed documents.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/kyc-acceptance-summary
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/experimental/organizations/unknown/reports/kyc-acceptance-summary?periodStart=string&periodEnd=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a KYC rejections report

Retrieve a KYC rejection report by type and by rejection reasons.

SecuritySecretApiKey or JWT
Request
query Parameters
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.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array of objects
Array
documentType
string (KycDocumentTypes)
Enum: "identity-proof" "address-proof" "funds-proof" "purchase-proof" "credit-file-proof"
Array of objects
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/kyc-rejection-summary
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/experimental/organizations/unknown/reports/kyc-rejection-summary?periodStart=string&periodEnd=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a KYC requests report

Retrieve a KYC request report by type and by rejection reasons.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

Responses
200

Report successfully retrieved.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array of objects
Array
rejectionReason
string (KycDocumentRequestStatuses)
Enum: "abandoned" "expired" "failed" "fulfilled" "pending-review"
count
integer <integer> >= 0

Number of related KYC requests.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/kyc-request-summary
Request samples
curl -i -X GET \
  'https://api-sandbox.rebilly.com/experimental/organizations/unknown/reports/kyc-request-summary?periodStart=string&periodEnd=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a monthly recurring revenue report

Retrieve a monthly recurring revenue report.

SecuritySecretApiKey or JWT
Request
query Parameters
currency
required
string (CurrencyCode) = 3 characters

Revenue currency.

Example: currency=USD
periodStart
required
string^\d{4}-\d{2}$

Report start date.

Example: periodStart=2022-01
periodEnd
required
string^\d{4}-\d{2}$

Report end date.

Example: periodEnd=2022-06
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array of objects
Array
period
string^\d{4}-\d{2}$

Revenue month.

total
number <double>

Total Monthly Recurring Revenue (MRR) amount.

object

MRR categories are described below. The difference between current period MRR and previous period MRR is equal to new + reactivated + expanded - contracted - churned.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/monthly-recurring-revenue
Request samples
const report = await api.reports.getMonthlyRecurringRevenue({
    periodStart: '2016-09',
    periodEnd: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
});
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a renewal sales report

Retrieve a renewal sales report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Date in format YYYY-MM.

newSales
number <double>

Amount of new sales.

newRefunds
number <double>

Amount of new refunds.

renewalSales
number <double>

Amount of renewal sales.

renewalRefunds
number <double>

Amount of renewal refunds.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/renewal-sales
Request samples
const params = {
    periodStart: '2017-09',
    periodEnd: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getRenewalSales(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a retention percentage report

Retrieve a retention percentage report.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

Enum: "day" "month" "quarter" "year"
aggregationPeriod
required
string

Report aggregation period.

Enum: "day" "month" "quarter" "year" "cycle"
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

includeSwitchedSubscriptions
string

If to include switched subscriptions.

Enum: "true" "false"
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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.

criteria
string

Criteria parameter for requesting a collection.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Value by which the report provides retention periods and percentages. The date values are displayed as following: Day: YYYY-MM-DD; Month: YYYY-MM; Quarter: YYYY-MM/YYYY-MM; Year: YYYY.

subscriptionsCount
integer

Number of subscriptions created within the aggregation.

Array of objects
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/retention-percentage
Request samples
const params = {
    aggregationField: 'month',
    aggregationPeriod: 'month',
    periodStart: '2016-09-01T00:00:00Z',
    periodEnd: '2017-09-01T00:00:00Z',
    includeSwitchedSubscriptions: false,
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getRetentionPercentage(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a retention value report

The retention value report shows the count of new customers. per aggregation bucket and the corresponding per customer value over time.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report aggregation field.

Enum: "day" "month" "quarter" "year" "leadsSource" "leadsMedium" "leadsCampaign" "leadsContent" "leadsTerm" "leadsAffiliate" … 2 more
aggregationPeriod
required
string

Report aggregation period.

Enum: "day" "month" "quarter" "year"
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

includeRefunds
string

If to include refunds.

Enum: "true" "false"
includeDisputes
string

If to include disputes.

Enum: "true" "false"
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

criteria
string

Criteria parameter for requesting a collection.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Value by which the report provides retention periods and values. The date values are displayed as following: Day: YYYY-MM-DD; Month: YYYY-MM; Quarter: YYYY-MM/YYYY-MM; Year: YYYY.

customersCount
integer

Number of customers within the aggregation with their first payment.

Array of objects
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/retention-value
Request samples
const params = {
    aggregationField: 'month',
    aggregationPeriod: 'month',
    periodStart: '2016-09-01T00:00:00Z',
    periodEnd: '2017-09-01T00:00:00Z',
    includeRefunds: true,
    includeDisputes: false,
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getRetentionValue(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a revenue waterfall report

Retrieve a revenue waterfall report.

SecuritySecretApiKey or JWT
Request
query Parameters
currency
required
string (CurrencyCode) = 3 characters

Revenue currency.

Example: currency=USD
issuedFrom
required
string^\d{4}-\d{2}$

Revenue invoice issued from month.

Example: issuedFrom=2022-01
issuedTo
required
string^\d{4}-\d{2}$

Revenue invoice issued to month.

Example: issuedTo=2022-04
recognizedTo
required
string^\d{4}-\d{2}$

Revenue recognized up to month.

Example: recognizedTo=2022-04
Responses
200

Report was retrieved successfully.

Response Schema: application/json
Array
issuedMonth
string^\d{4}-\d{2}$

Revenue invoice issue month.

booked
number <double>

The revenue amount booked at issue month.

recognized
number <double>

The revenue amount regognized up to recognizedTo month.

remaining
number <double>

The revenue amount remaining to be recognized after recognizedTo month.

Array of objects

Per month recognized revenue waterfall.

Array
recognizedMonth
string^\d{4}-\d{2}$

Revenue recognition month.

amount
number <double>

The revenue amount recognized at recognizedMonth.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/revenue-waterfall
Request samples
const report = await api.reports.getRevenueWaterfall({
    issuedFrom: '2016-09',
    issuedTo: '2017-09',
    recognizedTo: '2017-09',
    limit: 20,
    offset: 0,
    tz: 0
});
Response samples
application/json
[
  • {
    }
]

Retrieve transactions with their plan data

Retrieve transactions with their plan data.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

aggregationField
required
string

Report aggregation field.

Enum: "planId" "websiteId" "canceledBy" "cancelCategory" "leadSource.source" "leadSource.medium" "leadSource.campaign" "leadSource.content" "leadSource.term" "leadSource.affiliate" … 2 more
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Aggregation value.

count
integer

Count of canceled subscriptions.

averageLength
number <double>

Average length of canceled subscription from start to end within the aggregation in seconds.

medianLength
number <double>

Median length of canceled subscription from start to end within the aggregation in seconds.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/subscription-cancellation
Request samples
const params = {
    aggregationField: 'day',
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getSubscriptionCancellation(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a subscription renewal report

Retrieve a subscription renewal report.

SecuritySecretApiKey or JWT
Request
query Parameters
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

Response Schema: application/json
Array of objects
Array
planId
string <= 50 characters

The resource ID. Defaults to UUID v4.

allRenewalCount
integer

All renewed subscriptions number.

allDunningCount
integer

All dunned subscriptions number.

abandonedCount
integer

Abandon subscriptions number.

paidRenewalCount
integer

Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal success rate.

paidDunningCount
integer

Number of paid dunned subscriptions. Divide by allDunningCount to know the dun success rate.

refundedRenewalCount
integer

Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal refund rate.

refundedDunningCount
integer

Number of paid dunned subscriptions. Divide by allDunningCount to know the dun refund rate.

chargebackRenewalCount
integer

Number of paid renewed subscriptions. Divide by allRenewalCount to know the renewal chargeback rate.

chargebackDunningCount
integer

Number of paid dunned subscriptions. Divide by allDunningCount to know the dun chargeback rate.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/subscription-renewal
Request samples
const params = {
    periodStart: '2017-09-21T00:00:00Z',
    periodEnd: '2017-09-28T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getSubscriptionRenewal(params);
Response samples
application/json
{
  • "data": [
    ]
}

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.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Retrieve a dispute delays in days report

Retrieve a dispute delays in days report, how much time between a. transaction and a dispute.

SecuritySecretApiKey or JWT
Request
query Parameters
aggregationField
required
string

Report will be aggregated by this field.

Enum: "website" "processor" "currency" "bin" "country" "rebillNumber" "retryNumber" "gatewayAccount" "transactionAmount"
periodStart
required
string

Report start date.

periodEnd
required
string

Report end date.

limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Selected aggregation field value (defined by query). It can be, for example, website or country. You define it in aggregationField param in query.

25th
integer

25th percentile.

50th
integer

50th percentile.

75th
integer

75th percentile.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/transactions-time-dispute
Request samples
const params = {
    aggregationField: 'website',
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getTransactionsTimeDispute(params);
Response samples
application/json
{
  • "data": [
    ]
}

Retrieve a transactions report

Retrieve a transactions report.

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" "gateway" "retryNumber" "plan" … 8 more
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

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

Report was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Pagination-Limit
integer

Items per page limit.

Pagination-Offset
integer

Pagination offset.

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

Selected aggregation field value.

authApprovedThroughput
integer

Approved auth transactions to all transactions percentage.

approvedThroughput
integer

Approved sale transactions to all transactions percentage.

authApprovalCount
integer

Approved auth transactions count.

disputesRate
integer

Disputed transactions to all approved sale and capture transactions percentage.

disputesCount
integer

Disputed transactions to all approved sale and capture transactions count.

salesCount
integer

Sales count.

salesValue
number <double>

Sales value.

salesAverage
number <double>

Sales average value.

refundsCount
integer

Refunds count.

refundsValue
number <double>

Refunds value.

amount
number <double>

Amount.

count
number <double>

Transactions count.

unapprovedCount
number <double>

Unapproved transactions count.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/reports/transactions
Request samples
const params = {
    aggregationField: 'website',
    periodStart: '2017-09-22T00:00:00Z',
    periodEnd: '2017-09-29T23:59:59Z',
    limit: 20,
    offset: 0,
    tz: 0
};
const report = await api.reports.getTransactions(params);
Response samples
application/json
{
  • "data": [
    ]
}