List Containers

Copied

                https://api.ocamba.com/v1/hood/containers

Returns a list of Containers

query Parameters

Name

Description

fieldsstring

Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.

Example: fields=field1,field2,field3

pagestring

The page number indicates which set of items will be returned in the response. The format of request is "page=N,M" where 'N' (required) represents page number and 'M' (optional) is number of items per page.

Examples:
N=1, M=20 → returns page 1 with 20 items
N=2, M=20 → returns page 2 with 20 items (items 21-40)
N=3 → returns page 3. The number of objects returned depends on the resource settings.

Example: page=1,10

sortstring

Sorts the response by specified field(s) with the option to specify sorting order (ascending by default, add prefix "-" for descending).

Examples:
GET /VERSION/hood/RESOURCE_NAME?sort=name → sorts per name, ascending
GET /VERSION/hood/RESOURCE_NAME?sort=-id → sorts per id descending
GET /VERSION/hood/RESOURCE_NAME?sort=id,-name → sorts per id ascending, then name descending

See tips for the list of sortable fields.

Example: sort=-field1,field2

q_fieldsstring

Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/hood/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring

Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/hood/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

Response status codes

200 - OK

Name

Description

items[ container ]

An array of all created items.

Container

Name

Description

account_idstring

The ID of the Account, generated by the Ocamba. This field is deprecated and will be removed in future. Please use partner as a replacement.

Example: 1000001

analyticsobject

Name

Description

domainstring

Location where the analytics of the Container are located.

Example: t.ocmthood.com

enabledboolean

Determines wheather the analytics of the Container are enabler or not.

Example: true

overrideboolean

When set, enabled field is checked in the background. Only for Android and IOS type containers.

Example: true

applicationsobject

Applications set to the Container.

Name

Description

appstring

The name of the app. Has to be a fully qualified domain name.

Example: example-app.com

create_timestring

Last update time of the Application. Timezone: GMT.

Example: 2021-10-30 14:27:26

include_subdomainsboolean

Determines if the Container includes subdomains of the app.

Example: true

codestring

Hood JS Code Snippet. Can be displayed only for web type containers.

Example:

company_idstring

The ID of the Company, generated by the Ocamba.

Example: 1000001

consentobject

Describes the consent

Name

Description

enabledboolean

Determines if the Consent approved or not.

Example: true

overrideboolean

When set, enabled field is checked in the background. Only for Android and IOS type containers.

Example: true

create_timestring

Create time of the Container. Timezone: GMT.

Example: 2021-10-29 12:47:00

creator_idstring

The ID of the Creator, generated by the Ocamba.

Example: 1000001

descriptionstring

The description of the Container.

Example: This is an example of description.

iconstring

The location where the image of the Container is stored. This icon is the icon of the first app in the applications collection.

Example: https://dev-storage.ocamba.com/6197120/hood/containerss/1099/icons/favicon.ico

idstring

The ID of the Container, generated by the Ocamba.

Example: 1000

namestring

Name of the Container

Example: Container Example

partner_idstring

The ID of the Partner, generated by the Ocamba.

Example: 1000001

pushobject

Asdf

Name

Description

apns_envstring

Determines the Apns P12 Environment

Example: production

Possible values: production sandbox

apns_p12string

Dependant on the environment field. Only valid as a base64 encoded string and with valid password, if the certificate requires any. Only for IOS type tags.

apns_p12_passwordstring

The password of the Apns P12 certificate. Only for IOS type containers.

domainstring

Example: t.ocmhood.com

enabledboolean

Determines if Push is enabled or not.

firebase_admin_sdk_jsonstring

Must be a base64 encoded string representing the FirebaseAdminSdk object. Only for Android type containers.

has_apns_p12boolean

Determines if the Apns P12 certificate had been set. Generated by the Ocamba. Only for IOS type containers.

has_firebase_admin_sdk_jsonboolean

Determines if the FirebaseAdminSdk object had been set. Generated by the Ocamba. Only for Android type containers.

overrideboolean

When set, enabled field is checked in the background. Only for Android and IOS type containerss.

Example: true

promptprompt

Prompt object.

Prompt

Name

Description

create_timestring

Create time of the Tag. Timezone: GMT.

Example: 2021-10-29 12:47:00

filters[ object ]

Array of prompt filter objects.

idstring

Id of the prompt. Generated by the Ocamba.

Example: 0cb3502c-7fee-49c3-8a27-39e3df66fc8e

namestring

Name of the Prompt.

Example: New Native Prompt

optionsobject

Key value pairs.

Name

Description

actionmessage_colorstring

Action message color in RGB hexadecimal code.

Example: d94552

background_colorstring

Background color in RGB hexadecimal code.

Example: 4a88d9

category[ object ]

Array of category objects. Each object consists of two keys, one is 'name' and second is 'label'. Label represents text displayed to end user, and 'name' represents programmatic variable name.

Example: [ {"name":"key1","label":"sport"}, {"name":"key2","label":"politics"}, {"name":"key3","label":"business"} ]

delaynumber

Trigger window prompt after N seconds.

Example: 4

iconstring

Icon URL.

Example: https://icon.com/favicon.ico

label_colorstring

Label color in RGB hexadecimal code.

Example: 4a88d9

onclickboolean

Trigger window prompt in event of any user click on page.

Example: true

oncustomstring

Trigger window prompt on custom event with specific string with name of event, document.dispatchEvent(new Event("bilosta"));

Example: event

onscrollboolean

Trigger window prompt in event of any user scroll.

Example: true

state_button_negative_promptstring

Negative button name.

Example: Don't Allow

state_button_positive_promptstring

Positive button name.

Example: Allow

state_text_promptstring

Text which will be shown on window prompt.

Example: Allow notifications on your device to get latest news.

subscribe_backgroundstring

Subscribe background color in RGB hexadecimal code.

Example: 9479d9

subscribe_colorstring

Subscribe color in RGB hexadecimal code.

Example: 9479d9

unsubscribe_colorstring

Unsubscribe color in RGB hexadecimal code.

Example: e6543e

typestring

Type of the Prompt

Example: native

Possible values: slide | bell | link | native | html

update_timestring

Last update time of the Tag. Timezone: GMT.

Example: 2021-10-30 14:27:26

service_workerobject

Only for web apps.

Name

Description

pathstring

Path of the Service Worker.

Example: /sw.js

scopestring

Scope of the service worker isn't adjustable yet.

Example: example-scope

vapid_public_keystring

Exists only for web type containers. Generated by the Ocamba.

Example: BCNgZE2uKpC0T9rx65suEzjsXlNz3kXxcVHcFjQ6tDLQpF8lsFd1XBuwdZ2JHPzvU1A8X6QZFtN1w63imLqKNbs

statsobject

Shows additional statistic information about containers.

Name

Description

pageviewsinteger

The total number of page views.

Example: 10

push_subscriptionsinteger

Total number of subscriptions.

Example: 2

push_unsubscriptionsinteger

Total number of unsubscriptions.

Example: 1

sessionsinteger

The total number of sessions.

Example: 6

usersinteger

The total number of users.

Example: 4

statusstring

Determines the status of the Container.

Example: active

Possible values: active verification rejected paused inactive pending disabled

tags[ container-tag ]

Array of tag objects.

Tag

Name

Description

create_timestring

Timezone: GMT.

Example: 2021-10-29 12:47:00

filters[ tag-filter ]

Tag filter

Name

Description

filters[ object ]

Array of filter objects. This object is the same as the tag filter object(including this field).

opstring

valuestring

Filter value. Minimum 1, maximum 1000 characters.

Example: Some-value

variablestring

Variable to filter.

Example: campaign

idstring

UUID

Example: 550e8400-e29b-41d4-a716-446655440000

js_codestring

Js code for custom-code type tag. Maximum length 102400 characters.

Example: var modal = document.createElement('div'); modal.style.position = 'fixed'; modal.style.top = '50%'; modal.style.left = '50%'; modal.style.transform = 'translate(-50%, -50%)'; modal.style.width = '300px'; modal.style.height = '150px'; modal.style.backgroundColor = 'white'; modal.style.border = '2px solid #000'; modal.style.zIndex = '9999'; modal.style.padding = '20px'; modal.style.boxShadow = '0 4px 8px rgba(0, 0, 0, 0.1)'; modal.style.textAlign = 'center'; modal.style.display = 'none'; // Hidden by default var modalMessage = document.createElement('p'); modalMessage.innerText = 'This is a modal created via Tag Manager!'; modal.appendChild(modalMessage); var closeButton = document.createElement('button'); closeButton.innerText = 'Close'; closeButton.style.marginTop = '10px'; closeButton.onclick = function() { modal.style.display = 'none'; modal.appendChild(closeButton);

namestring

Name of the Container Tag. Must be unique per container.

Example: Container Tag Example

targetstring

Describes the element into which the tag will be inserted. Can be head, body, before-body-end, before-head-end or a custom css selector. Maximum 100 characters

Example: head

triggersobject

Name

Description

consent_initiationboolean

Describes if consent initiation trigger is turned on.

element_visibility[ tag-element-visibility ]

Allows to set tag to fire when certain elements of a page are visible.

element-visibility

Name

Description

min_on_screen_timenumber (integer)

Minimum on screen time of the element for trigger to fire in milliseconds. Minimum value 100, maximum value 30000.

Example: 200

min_percent_visiblenumber (decimal)

Minimum percentage of element visible to fire the trigger. Minimum value 1, maximum value 100.

Example: 2.22

observe_dom_changesboolean

Example: true

selectorstring

Identifies the correct element to select. Accepts both css selector name and element id. Maximum length 50 characters.

Example: .class

when_to_firestring

Describes when the tag is fired.

Example: once-per-page

Possible values: once-per-page | once-per-element | every-time

form_submissionobject

Name

Description

check_validationboolean

Describes if trigger should check if the form meets validation rules before firing.

wait_for_tagsnumber (integer)

Describes how long the trigger will wait for additional tags before firing in milliseconds. Minimum value 100, maximum 30000.

Example: 1200

page_viewboolean

Describes if page view trigger is turned on.

scroll_depthobject

Set conditions for firing a tag, based on scrolling behaviour.

Name

Description

enable_onstring

Describes when the trigger will be loaded.

Example: window-load

Possible values: container-load | window-load | dom-ready

horizontalscroll-options

Allows the user to finely tune the conditions for firing a tag based on user horizontal scroll behaviour.

Scroll options

Name

Description

percentagenumber (integer)

Describes how far a user needs to scroll for tag to fire in pixels. Minimum 1, maximum 100.

Example: 75

pixelsnumber (integer)

Describes how far a user needs to scroll for tag to fire in pixels. Minimum 1, maximum 3840.

Example: 1223

verticalscroll-options

Allows the user to finely tune the conditions for firing a tag based on user horizontal scroll behaviour.

typestring

Describes the type of tag.

Example: custom-code

Possible values: custom-code

update_timestring

Timezone: GMT.

Example: 2021-10-30 14:27:26

typestring

Determines the type of application the Container is suited for.

Example: web

Possible values: web android ios

update_timestring

Last update time of the Container. Timezone: GMT.

Example: 2021-10-30 14:27:26

utm_htstring

This is a UTM Hood Tracker. Generated by the Ocamba.

Example: NjY4bL60N1eBPTQ2PC4xNDY4MjE0Njlh

totalinteger

A total number of items.

Example: 15

tip

1 Sortable fields are: id, partner_id, account_id, name, status, create_time, update_time.

warning

1 In order to read partner, account or stat fields you can use predefined response (view=full). At the moment it is not possible to read those fields using fields parameter (fields=partner,account,stats) and this kind of request will result with an error.

Response examples

Copied

200

{
  "total": 15,
  "items": [
    {
      "id": "1000",
      "company_id": "1000001",
      "partner_id": "1000001",
      "account_id": "1000001",
      "creator_id": "1000001",
      "type": "web",
      "name": "Container Example",
      "description": "This is an example of description.",
      "status": "active",
      "tags": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "Container Tag Example",
          "type": "custom-code",
          "js_code": "var modal = document.createElement('div');\nmodal.style.position = 'fixed';\nmodal.style.top = '50%';\nmodal.style.left = '50%';\nmodal.style.transform = 'translate(-50%, -50%)';\nmodal.style.width = '300px';\nmodal.style.height = '150px';\nmodal.style.backgroundColor = 'white';\nmodal.style.border = '2px solid #000';\nmodal.style.zIndex = '9999';\nmodal.style.padding = '20px';\nmodal.style.boxShadow = '0 4px 8px rgba(0, 0, 0, 0.1)';\nmodal.style.textAlign = 'center';\nmodal.style.display = 'none'; // Hidden by default\n\nvar modalMessage = document.createElement('p');\nmodalMessage.innerText = 'This is a modal created via Tag Manager!';\nmodal.appendChild(modalMessage);\n\nvar closeButton = document.createElement('button');\ncloseButton.innerText = 'Close';\ncloseButton.style.marginTop = '10px';\ncloseButton.onclick = function() {\nmodal.style.display = 'none';\n\nmodal.appendChild(closeButton);\n",
          "triggers": {
            "element_visibility": [
              {
                "selector": ".class",
                "when_to_fire": "once-per-page",
                "min_percent_visible": 2.22,
                "min_on_screen_time": 200,
                "observe_dom_changes": true
              }
            ],
            "scroll_depth": {
              "horizontal": {
                "percentage": 75,
                "pixels": 1223
              },
              "vertical": {
                "percentage": 75,
                "pixels": 1223
              },
              "enable_on": "window-load"
            },
            "form_submission": {
              "wait_for_tags": 1200
            }
          },
          "filters": [
            {
              "variable": "campaign",
              "value": "Some-value",
              "filters": [
                {
                  "variable": "campaign",
                  "value": "Some-value"
                }
              ]
            }
          ],
          "target": "head",
          "create_time": "2021-10-29 12:47:00",
          "update_time": "2021-10-30 14:27:26"
        }
      ],
      "applications": {
        "app": "example-app.com",
        "include_subdomains": true,
        "create_time": "2021-10-30 14:27:26"
      },
      "icon": "https://dev-storage.ocamba.com/6197120/hood/containerss/1099/icons/favicon.ico",
      "utm_ht": "NjY4bL60N1eBPTQ2PC4xNDY4MjE0Njlh",
      "push": {
        "override": true,
        "domain": "t.ocmhood.com",
        "apns_env": "production",
        "vapid_public_key": "BCNgZE2uKpC0T9rx65suEzjsXlNz3kXxcVHcFjQ6tDLQpF8lsFd1XBuwdZ2JHPzvU1A8X6QZFtN1w63imLqKNbs",
        "service_worker": {
          "path": "/sw.js",
          "scope": "example-scope"
        },
        "prompt": {
          "id": "0cb3502c-7fee-49c3-8a27-39e3df66fc8e",
          "name": "New Native Prompt",
          "type": "native",
          "options": {
            "onscroll": true,
            "onclick": true,
            "oncustom": "event",
            "delay": 4,
            "state_text_prompt": "Allow notifications on your device to get latest news.",
            "state_button_positive_prompt": "Allow",
            "state_button_negative_prompt": "Don't Allow",
            "icon": "https://icon.com/favicon.ico",
            "background_color": "4a88d9",
            "actionmessage_color": "d94552",
            "unsubscribe_color": "e6543e",
            "subscribe_color": "9479d9",
            "subscribe_background": "9479d9",
            "label_color": "4a88d9",
            "category": [
              null
            ]
          },
          "filters": [
            {
              "key": "key-example",
              "match": "match-example"
            }
          ],
          "create_time": "2021-10-29 12:47:00",
          "update_time": "2021-10-30 14:27:26"
        }
      },
      "analytics": {
        "enabled": true,
        "override": true,
        "domain": "t.ocmthood.com"
      },
      "consent": {
        "enabled": true,
        "override": true
      },
      "code": "<script>!function(h,oo,d,y,t,a,g){h[y]=t[y]||function(){(h[y].q=h[y].q||[]).push(arguments)},h[y].l=1*new Date,a=oo.createElement(d),g=oo.getElementsByTagName(d)[0],a.async=1,a.crossOrigin='anonymous',a.src=t,g.parentNode.insertBefore(a,g)}(window,document,'script','Hood','https://dev-sdk.ocmhood.com/sdk/ht.js?tag=NjY4bL60Nma9sTQ2AuAxNDY4MjE0NvHt');</script>",
      "stats": {
        "pageviews": 10,
        "sessions": 6,
        "users": 4,
        "push_subscriptions": 2,
        "push_unsubscriptions": 1
      },
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}

List Containers

GET /containersCopied https://api.ocamba.com/v1/hood/containers

GET /containers
Copied
`https://api.ocamba.com/v1/hood/containers`