This API allows you to retrieve detailed information about your app template campaigns. The campaigns in the App Templates, App Survey, App Template from Push, and Architect journeys can return in the response if available.
You can either:
- Search for a specific campaign using its ID or
- Filter campaigns created within a specific date range.
Endpoint and Headers
Visit our Postman collection to test this request.
Headers
| Header | Sample Value | Description |
|---|---|---|
| X-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 |
|---|---|---|
| inapp_id | The ID of the app template | Integer |
| created_between | The dates between which the campaigns are created | Object |
| from | The start date of the date range | String |
| to | The end date of the date range | String |
Sample Body
Before sending the request, make sure to replace the values in your request body. Below is an example for the created_between parameter.
curl --location 'https://mobile.api.useinsider.com/v1/details/inapp' \
--header 'X-Api-Key: 1a2b3c4d5e' \
--header 'Content-Type: application/json' \
--data '{
"created_between": {
"from": "2025-01-16",
"to": "2025-04-15"
}
}'
Below is an example for the inapp_id parameter.
curl --location 'https://mobile.api.useinsider.com/v1/details/inapp' \
--header 'X-Api-Key: 1a2b3c4d5e' \
--header 'Content-Type: application/json' \
--data '{
"inapp_id": 1434
}'
Sample Responses
The following are some example responses you might receive for your request.
200 OK
The following is a sample response for the created_between parameter.
{
"data": [
{
"inapp_id": 2,
"linked_push_id": 3,
"linked_push_type": "conversion",
"name": "My campaign",
"created_by": "test@useinsider.com",
"status": "passive",
"is_inapp_from_push": true,
"is_inapp_from_architect": false,
"created_at": "2025-01-01T15:08:55Z",
"start_date": "2024-01-01T15:08:56Z",
"updated_at": "2023-01-05T15:08:55Z",
"end_date": "2024-01-01T15:08:57Z",
"variations": [
{
"variation_id": 1,
"percentage": 50,
"variation_name": "Variant A",
"type": "wheelOfFortune"
},
{
"variation_id": 2,
"percentage": 50,
"variation_name": "Control Group",
"type": "wheelOfFortune"
}
],
"tags": [
"tagName2"
]
},
{
"inapp_id": 3,
"name": "Our campaign",
"created_by": "test@useinsider.com",
"status": "draft",
"is_inapp_from_push": false,
"is_inapp_from_architect": false,
"created_at": "2025-01-02T15:08:55Z",
"start_date": "2024-01-01T15:08:56Z",
"updated_at": "2023-01-05T15:08:55Z",
"end_date": "2024-01-01T15:08:57Z",
"variations": [
{
"variation_id": 3,
"percentage": 50,
"variation_name": "Variant A",
"type": "wheelOfFortune"
},
{
"variation_id": 4,
"percentage": 50,
"variation_name": "Control Group",
"type": "wheelOfFortune"
}
],
"tags": [
"tagName3"
]
},
{
"inapp_id": 4,
"journey_id": 15,
"name": "This campaign",
"created_by": "test@useinsider.com",
"status": "active",
"is_inapp_from_push": false,
"is_inapp_from_architect": true,
"created_at": "2025-01-03T15:08:55Z",
"start_date": "2024-01-01T15:08:56Z",
"updated_at": "2023-01-05T15:08:55Z",
"variations": [
{
"variation_id": 5,
"percentage": 50,
"variation_name": "Variant A",
"type": "wheelOfFortune"
}
]
}
]
}
The following is a sample response for the inapp_id parameter.
{
"data": [
{
"inapp_id": 2,
"name": "My campaign",
"linked_push_id": 3,
"linked_push_type": "conversion",
"created_at": "2024-01-01T15:08:55Z",
"created_by": "test@useinsider.com",
"status": "passive",
"is_inapp_from_push": true,
"is_inapp_from_architect": false,
"start_date": "2024-01-01T15:08:56Z",
"end_date": "2024-01-01T15:08:57Z",
"updated_at": "2023-01-05T15:08:55Z",
"variations": [
{
"variation_id": 1,
"percentage": 50,
"variation_name": "Variant A",
"type": "wheelOfFortune"
},
{
"variation_id": 2,
"percentage": 50,
"variation_name": "Control Group",
"type": "wheelOfFortune"
}
],
"tags": [
"tagName2"
]
}
]
}
400 Bad Request
The following is a sample response for a request where the API key is missing.
{
"error": "No api key provided"
}
400 Bad Request
The following is a sample response for a request where the payload is invalid.
{
"error": "invalid request payload"
}
400 Bad Request
The following is a sample response for a request where the required parameter is missing.
{
"error": "either 'inapp_id' or 'created_between' must be provided"
}
400 Bad Request
The following is a sample response for a request where the payload has both parameters while it requires only one.
{
"error": "provide either 'inapp_id' or 'created_between', not both"
}
400 Bad Request
The following is a sample response for a request where the date format is incorrect for the from parameter.
{
"error": "invalid date format for 'from'; expected format is YYYY-MM-DD"
}400 Bad Request
The following is a sample response for a request where the date format is incorrect for the to parameter.
{
"error": "invalid date format for 'to'; expected format is YYYY-MM-DD"
}
400 Bad Request
The following is a sample response for a request where the to date is not greater than or equal to the from date.
{
"error": "'to' date must be after or equal to 'from' date"
}
400 Bad Request
The following is a sample response for a request where the date range exceeds 90 days.
{
"error": "date range must not exceed 90 days"
}
404 Not Found
The following is a sample response for a request where no inapp is found.
{
"error": "inapp not found"
}
403 Forbidden
The following is a sample response for a request where the API key is invalid.
{
"error": "Invalid api key"
}
Limitations
- All functions must be executed with a simple HTTPS POST request.
- The rate limit is 1000 requests per minute.
- Only one of the filters (inapp_id or created_between) can be used at a time.
- The date range must be 90 days or less.
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.