Get SMS Campaign Analytics

SMS Campaign Analytics details will be listed when you send a request to this API.

This API does not contain Architect Analytics.

Endpoints and Headers

POST https://sms.useinsider.com/analytics/v1/campaign

Visit our Postman collection to test this request.

Headers

Header	Sample Value	Description
X-INS-AUTH-KEY	1a2b3c4d5e6f	This key is required to authorize your request. Refer to API Authentication Tokens to generate your token.

Body Parameters

Parameter	Data Type	Description	Required
campaignId	Integer	Your campaign ID can be found on the campaign URL	Yes

Sample Request

Before sending the request, make sure:

To replace the authorization value with your API key.
To replace the sample values in campaignID with your value in the required data type.

Below is a sample request to retrieve SMS analytics data for a specific campaign by its campaign ID.

curl --location 'https://sms.useinsider.com/analytics/v1/campaign' \
--header 'x-ins-auth-key: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data '{
    "campaignId": 11242
}'

Sample Responses

200 Ok

{
   "targeted":0,
   "messageParts":0,
   "sent":0,
   "dropped":0,
   "delivery":{
      "count":{
         "delivered":0,
         "undelivered":0
      },
      "rate":"0.00%"
   },
   "clickThrough":{
      "clicks":0,
      "rate":"0.00%",
      "revenue":"0"
   },
   "conversion":{
      "conversions":0,
      "rate":"0.00%"
   },
   "unsubscribers":{
      "count":0,
      "rate":"0.00%"
   },
   "droppedMessages":{
      "frequencyCapped":{
         "count":0,
         "rate":"0.00%"
      },
      "duplicates":{
         "count":0,
         "rate":"0.00%"
      },
      "internalErrors":{
         "count":0,
         "rate":"0.00%"
      },
      "countryCodeDrops":{
         "count":0,
         "rate":"0.00%"
      },
      "invalidPhoneNumbers":{
         "count":0,
         "rate":"0.00%"
      },
      "couponListDrops":{
         "count":0,
         "rate":"0.00%"
      },
      "silentHours":{
         "count":0,
         "rate":"0.00%"
      }
   },
   "undeliveredMessages":{
      "carrierViolations":{
         "count":0,
         "rate":"0.00%",
         "details":[
            
         ]
      },
      "hardBounces":{
         "count":0,
         "rate":"0.00%",
         "details":[
            
         ]
      },
      "softBounces":{
         "count":0,
         "rate":"0.00%",
         "details":[
            
         ]
      },
      "deliveryFailures":{
         "count":0,
         "rate":"0.00%",
         "details":[
            
         ]
      },
      "deliveryReportMissing":{
         "count":0,
         "rate":"0.00%"
      }
   }
}

You can refer to SMS Campaign Analytics Metrics for further details.

401: Unauthorized request. Please make sure of your authorization key's correctness
422: This campaign ID is not valid. Please be sure that your campaign ID belongs to your account.

Limitations

All functions must be executed with an HTTPS POST request.
The X-INS-AUTH-KEY should be provided as the authorization key in the request header. If the key is incorrect, the operation will not be executed, and an authorization error will be returned in the response.
This API provides data for a 1-year range.
You can send 100 requests per minute with the same API Key. The perPage value should be between 1 and 100.

The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team — we can adjust it to fit your needs.