Push zone

GET /pushes/{track_id}
Copied
Arrow
                https://feed.ocmxr.com/v1/pushes/{track_id}

Real-time bidding programmatic zone, used by push notification clients, usually in JSON format

path Parameters
Arrow
Name
Description
track_idstringrequired
A unique identifier generated by the Ocamba platform.


Example: AFU1kAAPZ_4
query Parameters
Arrow
Name
Description
uastring
User browser user agent. If not provided through query param, field is extracted from HTTP request header 'User-Agent'.


Example: ua=Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_15_7%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F90.0.4430.93+Safari%2F537.36
numnumber
Maximum number of ads returned.


Example: num=1
ipstring
IP address of device closest to user. If not provided through query param, address is extracted from network remote address.


Example: ip=185.10.2.4
langstring
User language of device. If not provided through query param, language is extracted from HTTP request header 'Accept-Language'.


Example: lang=en,lang=en,sr
subidstring
Publisher id.


Example: subid=11231-campaign
pagestring
Location of page where ad should be placed. If not provided through query param, page is extracted from HTTP request header 'Referrer' or 'Origin'.


Example: page=https%3a%2f%2ftest.com%2fc572a60c-09fa-4e2a-bb27
catstring
IAB categories of page where ad is shown.


Example: cat=IAB1,IAB2-1
kwstring
Keyword specified for particular bid request.


Example: kw=best%20hotels
bfnumber
Minimal bid expected in bidResponse.


Example: bf=0.01
cmpnumber
Ocamba adex campaign ids to be considered in bidResponse.


Example: cmp=100101
crenumber
Ocamba adex creatives ids to be considered in bidResponse.


Example: cre=100101
vasnumber
Ocamba adex groups ids to be considered in bidResponse.


Example: vas=41
accnumber
Ocamba adex accounts ids to be considered in bidResponse.


Example: acc=784839
ud_${KEY}string
Custom user data, provided in real-time bidding reqeust, inside query param where "ud_" is static prefix and what it follows is key. T


Example: ud_clicker=1
rt_${ID}string
Retargeting ID, provided by client. Parameter is usefull if partner's platform has it's own user ID, this way mapping between Ocamba user ID and partner ID established.


Example: rt_1=3083bef2-824d-416b-80bc-63b660ac27ad-tuctbb20bfd
ch_uastring
User-agent client hint, should be provided by client. The corresponding header-value is "Sec-CH-UA"


Example: ch-ua=%22Samsung%20Internet%22%3Bv%3D%2224.0%22%2C%20%22Chromium%22%3Bv%3D%22117%22%2C%20%22Not%3BA%3DBrand%22%3Bv%3D%228%22
ch-ua-pstring
User-agent client hint, should be provided by client. The corresponding header-value is "Sec-CH-UA-Platform"


Example: ch-ua-p=%22Android%22
ch-ua-mstring
User-agent client hint, should be provided by client. The corresponding header-value is "Sec-CH-UA-Mobile"


Example: ch-ua-m=%3F1
user_idnumber
Hood user ID, provided by Ocamba platform.


Example: user_id=16898146561594009707
verstring
Client version, provided by Ocamba clients. Clients are Hood Web SDK, Android SDK, iOS SDK.


Example: ver=2.1.22
date_subnumber
User push subscription timestamp in seconds.


Example: date_sub=1689814656
exec_tsnumber
User push subscription timestamp in seconds.


Example: exec_ts=1713550200
oappidnumber
Hood tag id, provided by Ocamba platform.


Example: oappid=2834010903
oappaccidnumber
Hood tag account id, provided by Ocamba platform.


Example: oappaccid=59966323
task_idnumber
Hood scheduler task id, provided by Ocamba platform.


Example: src=push-source-1
srcstring
Traffic source, provided by user.


Example: src=push-source-1

Response status codes
Arrow
200 - OK
Arrow
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "t": [
    "https://t.ocmant.com/imp?l2=m31ujtXBQV6T0CfTp3xN4cS74HSt-NJQpnHICre9dWIl4QpwmPuCZfKO8QS28BvkGEqK6dCiE65Z3-iEuzeS3ZMO16dqW2R_0uQzQXL4zKaRwrpFxKjdei5RYUq703JDp37vnRWymKIqOS7lBdzB0ZAxpwX1vH7S29PBJFKrlVgp0bi9R6NddsGrwqcEA3BD89OTpksGqrIuwX5kpSqDNM1sGfUL3P7R5D-K3W9ZJ1ly0nzr3I5TFsGIRwnUbLs8WK3-e5PVolQ1OZRYs2voPA"
  ],
  "p": [
    {
      "t": "Here goes title!",
      "o": {
        "requireInteraction": true,
        "data": {
          "url": "https://t.ocmant.com/aclk?u=https%3a%2f%2fb92.net%2fsport&l2=m31ujtXBQV6T0CfTp3xN4cS74HSt-NJQpnHICre9dWIl4QpwmPuCZfKO8QS28BvkGEqK6dCiE65Z3-iEuzeS3ZMO16dqW2R_0uQzQXL4zKaRwrpFxKjdei5RYUq703JDp37vnRWymKIqOS7lBdzB0ZAxpwX1vH7S29PBJFKrlVgp0bi9R6NddsGrwqcEA3BD89OTpksGqrIuwX5kpSqDNM1sGfUL3P7R5D-K3W9ZJ1ly0nzr3I5TFsGIRwnUbLs8WK3-e5PVolQ1OZRYs2voPA&_a=${OA_BACID}"
        },
        "body": "Here goes some nice description",
        "actions": [
          {
            "url": "https://t.ocmant.com/aclk?u=https%3a%2f%2fgoogle.com&l2=m31ujtXBQV6T0CfTp3xN4cS74HSt-NJQpnHICre9dWIl4QpwmPuCZfKO8QS28BvkGEqK6dCiE65Z3-iEuzeS3ZMO16dqW2R_0uQzQXL4zKaRwrpFxKjdei5RYUq703JDp37vnRWymKIqOS7lBdzB0ZAxpwX1vH7S29PBJFKrlVgp0bi9R6NddsGrwqcEA3BD89OTpksGqrIuwX5kpSqDNM1sGfUL3P7R5D-K3W9ZJ1ly0nzr3I5TFsGIRwnUbLs8WK3-e5PVolQ1OZRYs2voPA&_a=1",
            "action": "1",
            "title": "Action button"
          }
        ]
      }
    }
  ]
}