Usage Tracker API
get/ping?type=custom
Query parameters
idstring
App ID - this may be used instead of the rf-app authorization header
device_typestring
Accepted values are web, roku_os, ios, tv_os, android_os (additional values for custom devices may be specified). Defaults to web if not specified.
typestring
Set to custom
custom_field_idstring
Set to the value of the custom tracker that has been created within Pulse
Headers
user-idstring
Unique identifier for the unauthenticated user
anonymous-user-idstring
Unique authenticated identifier for the user
Response
200
Example response
{
"paths": [
{
"name": "Test prompt",
"device_type": "web",
"path_type": 5,
"zone": "rf-hero",
"settings": {
"iab": "custom",
"width": "960px",
"height": "300px"
},
"order": 1,
"triggers": [
{
"custom_trigger_seconds": 2,
"id": "67168f70-e4c8-4736-9e78-fae99e1ab5f3",
"trigger_type": "web",
"url_path": "*"
}
],
"action_group_id": "a66822a2-6372-4c1b-a667-7ca2fedc3eec",
"action_group_name": "Variation 2",
"path_group_slug": "d201bc9f-2bd6-4ae3-a1b2-990f0e6d2203",
"id": "0493d247-c1b2-40e4-8682-819825cbb822",
"actions": {
"rf_retention_title": "Movies without limits",
"rf_retention_message": "Download New Episodes. Brand new full length episodes you can watch while offline. Free for 1 month.",
"rf_settings_bg_image_web_desktop_preview_dims": "960x300",
"rf_settings_bg_image_web_desktop_composite": "https://img.redfast.com/image.jpg",
"rf_settings_bg_image_web_mobile_composite": "https://img.redfast.com/image2.jpg"
},
"zone_type": "code"
}
],
"segments": [
{
"name": "All Users",
"id": "bae47505-4674-43c7-876c-3d39d71dbbd6"
}
],
"configs": {
"ping_frequency": 300,
"last_update": 1574340818,
"device_type": "web"
},
"anonymous_user_id": "92276d8c7723448f219ae70fda3a29cc1b6eccd4d36b985f9d533ef3f21125f4",
"visitor_id": "test123"
}