get https://api.gliderpay.com/glider/report/v1/batch.json/
Returns an overall report of a single batch.
A batch number identifier must be specified in the API request, this can be obtained while creating a new Glider Batch or from a separate Report API.
| Parameter | Description | Example |
|---|---|---|
| batchId | Batch number identifier | 50 |
- Parameters
- batchId (required, number,
50) ... Glider batch identifier.
- batchId (required, number,
API response values are described in the table below:
| Name | Description | Example |
|---|---|---|
| batchId | Batch number identifier | 50 |
| name | Batch name | Campaign XYZ |
| marketingId | Identifier for the related notification campaign | 5 |
| scheduled | Scheduled time for the invoice campaign | 2023-01-01 10:10:10 |
| isSingle | Boolean flag for Glider widget campaign only | false |
| channel | Notification channel (mobile, email, link) | mobile |
| plans | Number of registered plan for the campaign | 3 |
| plansAmount | Amount (in dollars) of the registered plans for the campaign | 3300.88 |
| template | Message template for the campaign ({subject: ..., body: ...} JSON format for email campaigns) | Hello {{name}}. Click on the url to pay your bill {{url}} |
| invoices | Total number of invoices in the batch | 3 |
| approvedInvoices | Total number of approved invoices | 2 |
| rejectedInvoices | Total number of rejected invoices | 1 |
| totalAmount | Total amount (in dollars) of approved invoices | 615.08 |
| smsSent | [DEPRECATED] Total amount of sms sent | 2 |
| smsDelivered | [DEPRECATED] Total amount of sms delivered | 2 |
| smsFailed | [DEPRECATED] Total amount of sms failed | 0 |
| smsPending | [DEPRECATED] Total amount of sms pending | 0 |
| visits | Total amount of visits to the unique urls created for this batch | 6 |
| approvedPayments | Total amount of approved payment transaction for this batch | 1 |
| declinedPayments | Total amount of declined payments for this batch | 0 |
| paymentAmount | Total amount (in dollars) of approved payment transactions | 200.00 |
| receipts | Total amount of requested receipts from the end-user | 1 |
| uniqueVisits | Number of unique visits for the campaign | 34 |
| notificationCredits | Amount of the credits used for the campaign | 6 |
| notificationDelivered | Amount of notification delivered for the campaign | 4 |
| notificationBounced | Amount of bounced notification for the campaign | 1 |