Use this endpoint to retrieve analytics for a single Web Push campaign over a specified date range. Unlike the Overall Metrics endpoint, which returns a paginated list of all campaigns, this endpoint returns full metric details for one campaign, including a device-level breakdown, drop reasons, and goal configuration.
The response corresponds to the data on the Web Push Campaign Level Analytics page in the InOne panel.
Endpoint and Headers
POST https://web-push.api.useinsider.com/v1/statistics/campaign-metrics
Visit our Postman collection to test this request.
Headers
Header | Sample Value | Description |
|---|---|---|
Authorization | Bearer 1a2b3c4d5e6f | This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. |
Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
Parameter | Description | Data Type | Required |
|---|---|---|---|
partner_id | This is your partner identification number, available from Inone Settings > Account Settings. | String | Yes |
start_date | This specifies the date on which you will start requesting campaign analytics. The date format should be YYYY-MM-DD. The Start Date cannot be earlier than the Campaign Create Date. | String | Yes |
end_date | This specifies the date on which you will stop requesting campaign analytics. The date format should be YYYY-MM-DD. | String | Yes |
campaign_id | The ID of the campaign to retrieve. Use the builderId value returned in the Overall Metrics response. Alternatively, find the campaign ID in the InOne panel by opening the campaign and copying the numeric ID from the URL. | String | Yes |
Sample Request
The sample below displays a request to fetch campaign metrics statistics for Web Push campaigns within a specific date range.
Before sending the request, make sure:
To replace the authorization value with your API key.
To replace the sample values in partner_id, start_date, end_date, and campaign_id with your values in the required data type.
curl --location --request POST 'https://web-push.api.useinsider.com/v1/statistics/campaign-metrics' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1a2b3c4d5e6f' \
--data '{
"partner_id": "YOURPARTNERID",
"start_date": "2023-06-01",
"end_date": "2023-06-08",
"campaign_id": "11111"
}'Sample Responses
200 OK
{
"success": true,
"message": "",
"name": "The campaign",
"statusName": "completed",
"status": 1,
"workingStatus": 3,
"sendType": 0,
"primaryGoal": "salesFromClick",
"startDate": "2023-10-31T21:00:00.000000Z",
"endDate": "2023-11-30T20:59:59.999999Z",
"isRecurring": false,
"alias": "single",
"preferredCurrency": "TRY",
"personalizationStatus": "Active",
"isTTLEnded": true,
"goalMenu": {
"camp-join": "Clicks",
"sales-from-click": "Purchases From Click..."
},
"overview": {
"total": {
"targeted": "1",
"deliveryRate": "100.00%",
"ctr": "0.00%",
"conversionRate": "0.00%"
},
"targeted": {
"sent": "1",
"dropped": "0"
},
"deliveryRate": {
"delivered": "1",
"undelivered": "0"
},
"ctr": {
"clicks": "0"
},
"conversionRate": {
"conversions": "0"
},
"revenue": "0 TRY"
},
"deviceMetrics": [
{
"device": "Desktop",
"sent": "1",
"delivered": "1",
"deliveryRate": "100.00%",
"clicks": "0",
"ctr": "0.00%",
"conversions": "0",
"conversionRate": "0.00%",
"revenue": "0 TRY"
},
{
"device": "Mobile",
"sent": "0",
"delivered": "0",
"deliveryRate": "0.00%",
"clicks": "0",
"ctr": "0.00%",
"conversions": "0",
"conversionRate": "0.00%",
"revenue": "0 TRY"
}
],
"unsuccessfulMessages": {
"dropped": [
{
"label": "frequencyCapped",
"count": "0",
"percentage": 0
},
{
"label": "unsubscriptions",
"count": "0",
"percentage": 0
},
{
"label": "serviceProviderErrors",
"count": "0",
"percentage": 0
},
{
"label": "internalErrors",
"count": "0",
"percentage": 0
}
],
"undelivered": [
{
"label": "offlineRecipients",
"count": "0",
"percentage": 0
},
{
"label": "other",
"count": "0",
"percentage": 0
}
]
},
"comparisonData": []
}You can refer to Web Push Campaign Level Analytics Metrics for further information.
401 Unauthorized
Returned when the Authorization header is missing, malformed, or contains an invalid token.
{
"message": "Unauthorized"
}424 Failed Dependency
Returned when the campaign_id does not match any existing campaign, or when an upstream service dependency fails. Verify that the campaign_id value matches the builderId from the Overall Metrics response. If the ID is correct and the error persists, contact the Insider One team.
{
"message": "SERVICE:-Campaign not found"
}Error Codes
400 Bad Request: Returned when a required parameter is missing, a date format is invalid, or start_date is later than end_date.
401 Unauthorized Request
424 Failed Dependency
429 Request limit exceeded: Returned when the request rate exceeds 30 requests per minute. Wait before retrying. See API Rate Limits for details.
Limitations
All functions must be executed with an HTTPS POST request.
The campaign_id must correspond to an existing campaign in your account. An invalid ID returns a 424 error.
The Authorization header must contain a valid API key. An invalid or missing key returns a 401 error.
The rate limit is 30 requests per minute.
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.