View a Container push prompt
View a Container push prompt
GET
https://api.ocamba.com/v1/hood/containers/{id}/prompts/{pid}
Retrieves the details of a Container push prompt that has previously been created if a valid identifier was provided
Tip
If you don’t know the container push prompt id, list the push prompts to find it.
Rate limits:
- Burst: 10/s
- Steady: 150/m
Path parameters
parametersQuery parameters
parametersResponse schemas
›
200
application/json
›
400
application/json
›
500
application/json
curl -X GET \
"https://api.ocamba.com/v1/hood/containers/{id}/prompts/{pid}" \
-H "Authorization: Bearer {TOKEN}"const url = 'https://api.ocamba.com/v1/hood/containers/{id}/prompts/{pid}';
const options = {
method: 'GET',
headers: {
Authorization: `Bearer {TOKEN}`
}
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}$ch = curl_init("https://api.ocamba.com/v1/hood/containers/{id}/prompts/{pid}");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer {TOKEN}"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);Responses
200 OK
{
"total": 1,
"items": [
{
"id": "1000001",
"uuid": "c3e25631-4030-409d-a021-5fb091b9d0b1",
"company_id": "1000001",
"container_id": "1000",
"status": "active",
"type": "html",
"name": "My first prompt",
"triggers": {
"element_visibility": {
"selector": ".class",
"when_to_fire": "once-per-page",
"min_on_screen_time": 200,
"observe_dom_changes": true
},
"scroll_depth": {
"horizontal": {
"percentage": 75,
"pixels": 1223
},
"vertical": {
"percentage": 75,
"pixels": 1223
}
},
"click_element": {
"enabled": true,
"element": "header"
},
"timer": 200,
"custom_event": {
"event": "my_event"
},
"require_all_triggers": true,
"dom_content_ready": true
},
"filters": [
{
"variable": "1000231",
"value": "Some-value",
"filters": [
{
"variable": "1000231",
"value": "Some-value"
}
]
}
],
"settings": {
"position": "top-left",
"background_color": "green",
"height": 500,
"width": 700,
"close_cta": true,
"close_esc": true,
"close_click": true,
"close_auto": 3000,
"delay": 2000,
"animation": "slide-up"
},
"ab_test_config": {
"num_of_appears": 1200,
"evaluation_window": 72,
"winning_metric": "click_rate",
"name": "My first ab test",
"winner_delivery_mode": "automatic"
},
"messages": [
{
"id": "1000001",
"company_id": "1000001",
"container_id": "1000",
"resource": "modal",
"resource_id": "1001241",
"experiment_id": "4245",
"template_id": "2141",
"name": "Big summer sale message",
"settings": {
"position": "top-left",
"background_color": "green",
"height": 500,
"width": 700,
"close_cta": true,
"close_esc": true,
"close_click": true,
"close_auto": 3000,
"delay": 2000,
"animation": "slide-up"
},
"variant": "A",
"winner": 1,
"create_time": "2021-10-29 12:47:00",
"update_time": "2021-10-30 14:27:26"
}
],
"position": 3,
"create_time": "2021-10-29 12:47:00",
"update_time": "2021-10-30 14:27:26"
}
]
}
400 Bad Request
{
"code": 400,
"title": "Bad request.",
"message": "The request is not valid.",
"trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
500 Internal Server Error
{
"code": 500,
"title": "Internal server error.",
"trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}
Responses