Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Insider One Web Push API
version: 1.0.0
description: 'Create, launch and delete single web push campaigns, plus web push statistics.
Derived by API Evangelist from Insider One''s own public Postman collection ("Insider One APIs", published at https://developers.insiderone.com/). Paths, methods, headers, query parameters and request/response examples are verbatim from that collection; nothing is invented. The 429 response is documented for all Insider One APIs on https://academy.insiderone.com/docs/api-rate-limits-1 .'
contact:
name: Insider One Support
email: support@useinsider.com
url: https://academy.insiderone.com/docs/insider-one-apis-1
termsOfService: https://insiderone.com/terms-of-use/
servers:
- url: https://web-push.api.useinsider.com
tags:
- name: Web Push
paths:
/v1/statistics/campaign-metrics:
post:
operationId: getWebPushCampaignMetricsAnalytics
summary: Get web push campaign metrics analytics
tags:
- Web Push
description: Insider's web push API allows you to get the campaigns analytics of your web push notifications from your own back-end without using the Insider's InOne panel.
security:
- Authorization: []
requestBody:
content:
application/json:
example:
partner_id: YOURPARTNERID
start_date: '2023-06-01'
end_date: '2023-06-08'
campaign_id: '11111'
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
/v1/statistics/overall-metrics:
post:
operationId: getWebPushOverallMetricsAnalytics
summary: Get web push overall metrics analytics
tags:
- Web Push
description: 'Insider''s web push API allows you to get the campaigns analytics of your web push notifications from your own back-end without using the Insider''s InOne panel. This API returns overall metric analytics with campaign information in the given time interval in API request payload.
Body Parameters
Parameter
Description
Data Type
Required
partner_id
This is your partner identification number, available from InOne Settings > Account Preferences.
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
Specifies the number of campaigns to be listed per page. Default value is 1.
String
No
per_page
Specifies the number of pages of campaign campaigns. Default value is 10.
String
No
Sample Example
Sample Request
Before sending the request, make sure:
To replace the authorization value with your own API key.
To replace the sample values in partner_id, start_date, and end_date with your own values in the required data type.
curl --location --POST ''https://web-push.api.useinsider.com/v1/statistics/overall-metrics'' \
--header ''Content-Type: application/json'' \
--header ''Authorization: {{vault:bearer-token}}'' \
--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": 2,
"total": 48,
"data": [
{
"id": 12345,
"tags": [
"Discount",
"Baby",
"Powder"
],
"type": "Bulk",
"campName": "08.06.2023-2100-BabyCare",
"status": "Active",
"builderId": 11111,
"sendDate": "2023-06-08 21:15:10",
"startDate": "2023-06-08 21:15:00",
"endDate": "2023-06-08 21:15:00",
"daysActive": 1,
"messageLink": "https://sample.useinsider.com/discount/all-baby-care-products",
"firstButtonLink": "N/A",
"secondButtonLink": "N/A",
"targeted": 411840,
"sent": 411344,
"dropped": 496,
"deliveryRate": 0.340792621261037,
"delivered": 140183,
"undelivered": 271161,
"ctr": 0.005157544067397616,
"clicks": 723,
"conversionRate": 0,
"conversions": 0,
"revenue": 0
},
{
"id": 22222,
"tags": [
"Baby"
],
"type": "Bulk",
"campName": "08.06.2023-Bebekcom-BabyProducts",
"status": "Active",
"builderId": 10101,
"sendDate": "2023-06-08 16:00:27",
"startDate": "2023-06-08 16:00:00",
"endDate": "2023-06-08 16:00:00",
"daysActive": 1,
"messageLink": "https://sample.useinsider.com/baby-products/",
"firstButtonLink": "N/A",
"secondButtonLink": "N/A",
"targeted": 411733,
"sent": 411279,
"dropped": 454,
"deliveryRate": 0.3351933845394489,
"delivered": 137858,
"undelivered": 273421,
"ctr": 0.008399947772345456,
"clicks": 1158,
"conversionRate": 0,
"conversions": 0,
"revenue": 0
}
]
}
401 UNAUTHORIZED
{
"status_code": 401
}
422 UNPROCESSABLE ENTITY
{
"status_code": 422,
"errors": {
"end_date": [
"The end date does not match the format Y-m-d."
]
}
}
Error Codes
400: Bad request
401: Unauthorized request
403: Request limit exceeded
422: Missing parameter
Limitations
All functions must be executed with an HTTPS POST request.
The API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
You can make 30 requests per minute in aggregate. Every response you receive from the API will include two additional headers specifying the number of requests that have been used and the maximum number of requests available for your account.'
security:
- Authorization: []
requestBody:
content:
application/json:
example:
partner_id: YOURPARTNERID
start_date: '2023-06-01'
end_date: '2023-06-08'
per_page: '100'
page: '1'
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
/v1/statistics/top-metrics:
post:
operationId: getWebPushTopMetricsAnalytics
summary: Get web push top metrics analytics
tags:
- Web Push
description: 'Insider''s web push API allows you to get the campaigns analytics of your web push notifications from your own back-end without using the Insider''s InOne panel. This API returns top metric analytics (without campaign information) in the given time interval in API request payload.
Body Parameters
Parameter
Description
Data Type
Required
partner_id
This is your partner identification number, available from InOne Settings > Account Preferences.
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
Sample Example
Sample Request
Before sending the request, make sure:
To replace the authorization value with your own API key.
To replace the sample values in partner_id, start_date, and end_date with your own values in the required data type.
curl --location --request POST ''https://web-push.api.useinsider.com/v1/statistics/top-metrics'' \
--header ''Content-Type: application/json'' \
--header ''Authorization: {{vault:bearer-token}}'' \
--data ''{
"partner_id": "YOURPARTNERID",
"start_date" : "2023-06-01",
"end_date" : "2023-06-08"
}''
Sample Responses
200 OK
{
"overview": {
"total": {
"targeted": "9,550,384",
"deliveryRate": "32.42%",
"ctr": "0.76%",
"conversionRate": "0.01%"
},
"targeted": {
"sent": "9,505,769",
"dropped": "44,615"
},
"deliveryRate": {
"delivered": "3,082,158",
"undelivered": "6,423,611"
},
"ctr": {
"clicks": "23,419"
},
"conversionRate": {
"conversions": "3"
},
"revenue": "2,480 TRY"
},
"performance": [
{
"label": "Bulk",
"campaignCount": 22,
"deliveryRate": "32.42",
"ctr": "0.76",
"conversionRate": "0.01",
"revenue": "2479.6600112915"
},
{
"label": "In Stock Alert",
"campaignCount": 4,
"deliveryRate": "0.00",
"ctr": "0.00",
"conversionRate": "0.00",
"revenue": "0"
},
{
"label": "Segment",
"campaignCount": 2,
"deliveryRate": "0.00",
"ctr": "0.00",
"conversionRate": "0.00",
"revenue": "0"
},
{
"label": "Cart Reminder",
"campaignCount": 4,
"deliveryRate": "0.00",
"ctr": "0.00",
"conversionRate": "0.00",
"revenue": "0"
},
{
"label": "Price Alert",
"campaignCount": 6,
"deliveryRate": "0.00",
"ctr": "0.00",
"conversionRate": "0.00",
"revenue": "0"
},
{
"label": "Trigger",
"campaignCount": 10,
"deliveryRate": "0.00",
"ctr": "0.00",
"conversionRate": "0.00",
"revenue": "0"
}
],
"dropped": [
{
"label": "frequencyCapped",
"count": "0",
"percentage": "0.00"
},
{
"label": "silentHours",
"count": "0",
"percentage": "0.00"
},
{
"label": "unsubscriptions",
"count": "44,203",
"percentage": "99.08"
},
{
"label": "serviceProviderErrors",
"count": "412",
"percentage": "0.92"
},
{
"label": "internalErrors",
"count": "0",
"percentage": "0.00"
}
],
"undelivered": [
{
"label": "offlineRecipients",
"count": "6,413,534",
"percentage": "99.84"
},
{
"label": "other",
"count": "10,077",
"percentage": "0.16"
}
]
}
401 UNAUTHORIZED
{
"status_code": 401
}
422 UNPROCESSABLE ENTITY
{
"status_code": 422,
"errors": {
"end_date": [
"The end date does not match the format Y-m-d."
]
}
}
Error Codes
400: Bad request
401: Unauthorized request
403: Request limit exceeded
422: Missing parameter
Limitations
All functions must be executed with an HTTPS POST request.
The API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.
You can make 30 requests per minute in aggregate. Every response you receive from the API will include two additional headers specifying the number of requests that have been used and the maximum number of requests available for your account.'
security:
- Authorization: []
requestBody:
content:
application/json:
example:
partner_id: YOURPARTNERID
start_date: '2023-06-01'
end_date: '2023-06-08'
responses:
'429':
$ref: '#/components/responses/TooManyRequests'
components:
responses:
TooManyRequests:
description: Too Many Requests. The published per-endpoint rate limit was exceeded; back off and retry, honouring Retry-After when present.
content:
application/json:
example:
message: Too Many Requests
status: 429
securitySchemes:
Authorization:
type: apiKey
in: header
name: Authorization
description: Authorization header. On gw.useinsider.com this carries an OAuth 2.0 Bearer token; on other hosts it carries the API key issued for that channel.
externalDocs:
description: Insider One API reference
url: https://academy.insiderone.com/docs/api-reference-welcome
x-provenance:
generated: '2026-08-13'
method: derived
source: postman/insider-one-apis.postman_collection.json
source_url: https://documenter.gw.postman.com/api/collections/24851117/2sB3dSR9bM
publisher_page: https://developers.insiderone.com/
note: Insider One publishes a single public Postman collection covering every REST API. This document is the subset of that collection served from web-push.api.useinsider.com.