Use this endpoint to retrieve per-campaign analytics for your Web Push notifications over a specified date range. Unlike the Top Metrics endpoint, which returns aggregated totals, this endpoint returns individual campaign records with full metric detail. Results are paginated.
The response corresponds to the data in the Web Push Analytics: Campaign Metrics section of the InOne panel.
Endpoint and Headers
POST https://web-push.api.useinsider.com/v1/statistics/overall-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, which is available in 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 |
page | The page number to retrieve in the paginated results. The default value is 1. | String | No |
per_page | The number of campaign records returned per page. Maximum value: 20. The default value is 10. | String | No |
Sample Request
The sample below displays a request to fetch overall 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, and end_date with your values in the required data type.
curl --location --request POST 'https://web-push.api.useinsider.com/v1/statistics/overall-metrics' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1a2b3c4d5e6f' \
--data '{
"partner_id": "YOURPARTNERID",
"start_date": "2023-12-02",
"end_date": "2023-12-19",
"page": 1,
"per_page": 10
}'Sample Responses
200 OK
{
"page": 1,
"per_page": 10,
"total": 65,
"data": [
{
"id": 16311,
"tags": [],
"groupLevels": [],
"type": "Back In Stock",
"campName": "In Stock",
"status": 1,
"workingStatus": 3,
"sendType": 0,
"statusName": "completed",
"builderId": 8893,
"sendDate": "-",
"startDate": "2023-09-15 18:23:00",
"endDate": "2023-09-15 18:26:00",
"daysActive": 1,
"messageLink": "",
"firstButtonLink": "{}",
"secondButtonLink": "N/A",
"targeted": 0,
"sent": 0,
"dropped": 0,
"deliveryRate": 0,
"delivered": 0,
"undelivered": 0,
"ctr": 0,
"clicks": 0,
"conversions": 0,
"conversionRate": 0,
"revenue": 0
}
]
}You can refer to Web Push Analytics Campaign Key Metrics for further details.
401 Unauthorized
Returned when the Authorization header is missing, malformed, or contains an invalid token.
{
"message": "Unauthorized"
}424 Failed Dependency
Returned when an upstream service dependency fails. Retry the request. If the error persists, contact the Insider One team.
{
"message": "SERVICE:-"
}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 Authorization header must contain a valid API key. An invalid or missing key returns a 401 error.
The per_page parameter has a maximum value of 20. Requests with a higher value will return an error.
The rate limit is 30 requests per minute. To request a higher limit, contact the Insider One team via the Help Center or refer to API Rate Limits.
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.