Message Center API allows you to get push notifications of any type delivered to your users during a defined time interval, including the push notifications delivered in Architect journeys and those you sent via mobile app APIs.
The system authorizes only the 127.0.0.1 IP by default. This IP restricts the requests to the Insider One APIs. To use the Mobile APIs, you must delete the default added IP or add your IPs to the IP Address Authorization list
Endpoint and Headers
Visit our Postman collection to test this request.
Headers
Header | Sample Value | Description |
|---|---|---|
X-INSIDER-API-KEY | 1a2b3c4d5e6f | This key is required to authorize your request. Refer to API Authentication Tokens to get your token. |
Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
Parameter | Description | Data Type | Required |
|---|---|---|---|
identifiers | User's identifier information. Identifiers can be Email, Phone Number, UUID (unique user ID), or a custom identifier. The identifiers need to be written in the mentioned case in the request, while the custom attribute needs to be written in the attribute_name format. Instead of the identifiers object, you can also use the insider_id key. | Object | Yes |
start_date | The start date of the timeline push notifications are delivered within, in timestamp format. | Integer | Yes |
end_date | The end date of the timeline push notifications are delivered within, in timestamp format. | Integer | Yes |
limit | Number of push notifications you can get in one request. The value can be between 1 and 100. | Integer | Yes |
Sample Body
The sample body below is for requesting user-related data by providing an identifier (email), along with a start and end date range, and a limit on the number of records to return.
Before sending the request, make sure to replace the values in your request body.
{
"identifiers": {
"Email": "j.doe@mail.com"
},
"start_date": 1633068172,
"end_date": 2143433430,
"limit": 100
}Below is a sample payload with the insider_id key instead of the identifiers object.
{
"insider_id": "12345",
"start_date": 1633068172,
"end_date": 2143433430,
"limit": 100
}Sample Responses
The following are some example responses you might receive for your request.
200 OK
The following is a sample response for a successful request with a limit of 3.
[
{
"camp_id": 650,
"camp_type": "Single Push",
"created_at": "2023-01-23T18:10:17Z",
"deep_links": {
"Page": "Cart",
"category": "insider_int_push",
"mutable-content": "1"
},
"message": "This is my message",
"title": "This is my title 💜 ",
"variant_id": 1907
},
{
"camp_id": 101,
"camp_type": "Recurring Push",
"created_at": "2023-01-18T21:00:21Z",
"deep_links": {
"MyKey01": "MyValue01"
},
"message": "New women's clothing has launched...",
"title": "Don't forget about me!",
"variant_id": 898
},
{
"camp_id": 132,
"camp_type": "Recurring Push",
"created_at": "2023-01-18T21:00:20Z",
"deep_links": {
"Page": "Cart",
"MyKey02": "MyValue02"
},
"message": "Your favorite items are waiting for you. ",
"title": "Retail",
"variant_id": 1122
}
]400 Bad Request
The following is a sample response for a request where the start date is greater than the end date.
bad payload400 Bad Request
The following is a sample response for a request where the limit is greater than 100.
limit should be between 1 and 100.401 Unauthorized
A request with an invalid API key will return a 401 Unauthorized response. Refer to API Authentication Tokens to get your API key.
Limitations
All functions must be executed with a simple HTTPS POST request.
The rate limit is 5000 requests per minute.
Each request can get push notifications only for one single user.
API returns only delivered pushes. The app_push_delivered event must be available.
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.