Retrieve Insights for a Batch File

Retrieve data related to a batch file in a specific campaign. This API returns statistics for all messages within the batch file.

Endpoint

GET /v1/insights/campaigns/{batchId}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

batchId REQUIRED

string (UUID)

Unique ID assigned to the batch.

Request Body

None

Returns

Returns message statistics for the specified batch file. For details, see the Insights object.

SAMPLE RESPONSE

				
					{
  "status": "0000",
  "message": "string",
  "result": {
    "submitted": 100,
    "processed": 100,
    "rejected": 0,
    "sent": 100,
    "delivered": 100,
    "failed": 0,
    "inProgress": 0
  }
}