Retrieve a API Log Summary Report.
Report was retrieved successfully.
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "route": "string",
- "total": 0,
- "get": 0,
- "post": 0,
- "put": 0,
- "patch": 0,
- "delete": 0,
- "head": 0,
- "options": 0
}
]
}
Retrieve a cumulative subscriptions report.
aggregationField required | string Report aggregation field. |
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. |
Report was retrieved successfully.
Array of objects | |||||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "aggregationValue": "string",
- "newCount": 0,
- "canceledCount": 0,
- "cumulativeCount": 0
}
]
}
Retrieve dashboard data.
Report was retrieved successfully.
metric | string Metric type. | ||||||||||||||
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
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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'
[- {
- "metric": "approvalRate",
- "humanName": "string",
- "increaseIsGood": true,
- "segments": [
- {
- "name": "string",
- "value": 0,
- "previousValue": 0,
- "humanValue": "string",
- "changeRatio": 0,
- "humanChangeRatio": "string",
- "timeseries": [
- {
- "date": "string",
- "value": 0
}
]
}
]
}
]
Retrieve a DCC markup report.
aggregationField required | string Report aggregation field. |
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. |
Report was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Array of objects | |||||||||||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "aggregationValue": "string",
- "selectedCount": 0,
- "selectedSum": 0,
- "rejectedCount": 0,
- "rejectedSum": 0,
- "unknownCount": 0,
- "unknownSum": 0
}
]
}
Retrieve a disputes report.
aggregationField required | string Report will be aggregated by this field. |
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. |
Report was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Array of objects | |||||||||||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
const params = { aggregationField: 'website', periodMonth: '2017-09', limit: 20, offset: 0, tz: 0 }; const report = await api.reports.getDisputes(params);
{- "data": [
- {
- "aggregationValue": "string",
- "countVisa": 0,
- "ratioCountVisa": 0,
- "ratioAmountVisa": 0,
- "countMastercard": 0,
- "ratioCountMastercard": 0,
- "ratioAmountMastercard": 0
}
]
}
Retrieve a events triggered summary report.
Report was retrieved successfully.
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "eventName": "dispute-created",
- "count": 0
}
]
}
Retrieve a rules matched summary report by events triggered.
eventType required | string (EventType) The system event type. |
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);
{- "data": [
- {
- "rule": "string",
- "count": 0,
- "approvalRate": 0
}
]
}
Retrieve a future renewals report.
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);
{- "data": [
- {
- "date": "string",
- "sum": 0,
- "plansCount": [
- {
- "planId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "count": 0
}
]
}
]
}
Retrieve a KYC acceptance summary report.
Report was retrieved successfully.
Array of objects | |||||||||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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'
{- "data": [
- {
- "documentType": "identity-proof",
- "statusStatistics": {
- "accepted": {
- "total": 6,
- "automatically": 4,
- "manually": 2,
- "afterAutoRejected": 2
}, - "rejected": {
- "total": 2,
- "automatically": 1,
- "manually": 1,
- "afterAutoAccepted": 1
}, - "pending": {
- "total": 0
}, - "archived": {
- "total": 0
}
}, - "total": 8,
- "accuracyRate": 62.5,
- "acceptanceRate": 75,
- "manualReviewTime": 0
}
]
}
Retrieve a KYC rejection report by type and by rejection reasons.
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'
{- "data": [
- {
- "documentType": "identity-proof",
- "rejectionReasons": [
- {
- "rejectionReason": "document-unreadable",
- "count": 0
}
]
}
]
}
Retrieve a KYC request report by type and by rejection reasons.
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'
{- "data": [
- {
- "rejectionReason": "abandoned",
- "count": 0
}
]
}
Retrieve a monthly recurring revenue report.
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. |
Report was retrieved successfully.
Unauthorized access, invalid credentials were used.
Access forbidden.
const report = await api.reports.getMonthlyRecurringRevenue({ periodStart: '2016-09', periodEnd: '2017-09', limit: 20, offset: 0, tz: 0 });
{- "data": [
- {
- "period": "2022-06",
- "total": 245,
- "breakdown": {
- "new": 40,
- "reactivation": 25,
- "churned": 80,
- "contraction": 20,
- "expansion": 60
}
}
]
}
Retrieve a renewal sales report.
const params = { periodStart: '2017-09', periodEnd: '2017-09', limit: 20, offset: 0, tz: 0 }; const report = await api.reports.getRenewalSales(params);
{- "data": [
- {
- "aggregationValue": "string",
- "newSales": 0,
- "newRefunds": 0,
- "renewalSales": 0,
- "renewalRefunds": 0
}
]
}
Retrieve a retention percentage report.
aggregationField required | string Report aggregation field. |
aggregationPeriod required | string Report aggregation period. |
periodStart required | string Report start date. |
periodEnd required | string Report end date. |
includeSwitchedSubscriptions | string If to include switched subscriptions. |
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. |
Report was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Array of objects | |||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "aggregationValue": "string",
- "subscriptionsCount": 0,
- "periods": [
- {
- "period": 0,
- "retentionRatio": 0,
- "canceledSubscriptionsCount": 0
}
]
}
]
}
The retention value report shows the count of new customers. per aggregation bucket and the corresponding per customer value over time.
aggregationField required | string Report aggregation field. |
aggregationPeriod required | string Report aggregation period. |
periodStart required | string Report start date. |
periodEnd required | string Report end date. |
includeRefunds | string If to include refunds. |
includeDisputes | string If to include disputes. |
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. |
Report was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Array of objects | |||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "aggregationValue": "string",
- "customersCount": 0,
- "periods": [
- {
- "period": 0,
- "retentionAverage": 0,
- "transactionsCount": 0,
- "transactionsValue": 0
}
]
}
]
}
Retrieve a revenue waterfall report.
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 |
Report was retrieved successfully.
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 |
remaining | number <double> The revenue amount remaining to be recognized after |
Array of objects Per month recognized revenue waterfall. | |
Unauthorized access, invalid credentials were used.
Access forbidden.
const report = await api.reports.getRevenueWaterfall({ issuedFrom: '2016-09', issuedTo: '2017-09', recognizedTo: '2017-09', limit: 20, offset: 0, tz: 0 });
[- {
- "issuedMonth": "2022-02",
- "booked": 25,
- "recognized": 20,
- "remaining": 5,
- "waterfall": [
- {
- "recognizedMonth": "2022-02",
- "amount": 4.4
}, - {
- "recognizedMonth": "2022-03",
- "amount": 8.33
}, - {
- "recognizedMonth": "2022-04",
- "amount": 7.27
}
]
}
]
Retrieve transactions with their plan data.
periodStart required | string Report start date. |
periodEnd required | string Report end date. |
aggregationField required | string Report aggregation field. |
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. |
Report was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Array of objects | |||||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "aggregationValue": "string",
- "count": 0,
- "averageLength": 0,
- "medianLength": 0
}
]
}
Retrieve a subscription renewal report.
Report was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Array of objects | |||||||||||||||||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "planId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "allRenewalCount": 0,
- "allDunningCount": 0,
- "abandonedCount": 0,
- "paidRenewalCount": 0,
- "paidDunningCount": 0,
- "refundedRenewalCount": 0,
- "refundedDunningCount": 0,
- "chargebackRenewalCount": 0,
- "chargebackDunningCount": 0
}
]
}
Retrieve a transactions report aggregated by time periods.
type required | string Report aggregation type. |
subaggregate required | string Report subaggregate. |
periodStart required | string Report start date. |
periodEnd required | string Report end date. |
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);
{- "data": [
- {
- "date": "string",
- "total": 0,
- "subaggregates": {
- "subaggregate": "string",
- "value": 0
}
}
]
}
Retrieve a dispute delays in days report, how much time between a. transaction and a dispute.
aggregationField required | string Report will be aggregated by this field. |
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. |
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);
{- "data": [
- {
- "aggregationFieldValue": "string",
- "25th": 0,
- "50th": 0,
- "75th": 0
}
]
}
Retrieve a transactions report.
periodStart required | string <date-time> Report start day. |
periodEnd required | string <date-time> Report end day. |
aggregationField required | string Report aggregation field. |
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. |
Report was retrieved successfully.
Pagination-Total | integer Total items count. |
Pagination-Limit | integer Items per page limit. |
Pagination-Offset | integer Pagination offset. |
Array of objects | |||||||||||||||||||||||||||||
Array
|
Unauthorized access, invalid credentials were used.
Access forbidden.
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);
{- "data": [
- {
- "aggregationFieldValue": "string",
- "authApprovedThroughput": 0,
- "approvedThroughput": 0,
- "authApprovalCount": 0,
- "disputesRate": 0,
- "disputesCount": 0,
- "salesCount": 0,
- "salesValue": 0,
- "salesAverage": 0,
- "refundsCount": 0,
- "refundsValue": 0,
- "amount": 0,
- "count": 0,
- "unapprovedCount": 0
}
]
}