List Tags

GET /tags
Copied
Arrow
                https://api.ocamba.com/v1/hood/tags

Returns a list of Tags

query Parameters
Arrow
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
Arrow
200 - OK
Arrow
Name
Description
items[ tag ]
An array of all created items.
Tag
Name
Description
accountobject
Relation to Ocamba Account.
Name
Description
configured_statusstring
The configured_status reflects the current status of the account configured by the client.


Example: active

Possible values: active | verification | rejected paused | inactive | archived
idstring
A unique identifier generated by the Ocamba platform.


Example: 1000001
imagestring (uri)
Represent the image of account.


Example: https://path/logo.jpeg
namestring
Name of the account.


Example: Demo Account
statusstring
The status reflects the current status of the account which may be overridden by some background processes.


Example: active

Possible values: active | verification | rejected paused | inactive | archived | hourly-limit | daily-limit | monthly-limit
account_idstring
The ID of the Account, generated by the Ocamba.


Example: 1000001
appsapps
All apps that belongs to the Tag, categorized by type.
Apps
Name
Description
android[ string ]
Array of Android applications. Every item in array must be a valid Android app unique identifier (Package name). Android app names are case sensitive.
ios[ string ]
Array of IOS applications. Every item in array must be a valid IOS app unique identifier (Bundle ID). iOS app names are case sensitive.
web[ string ]
Array of Web applications. Every item in array must be a fully qualified domain name. Web app names are case insensitive and are sanitized to be lowercase.
codestring
Hood JS Code Snippet.
company_idstring
The ID of the Company, generated by the Ocamba.


Example: 1000000
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
creator_idstring
The ID of the Member who create the Tag, generated by the Ocamba.


Example: 1000002
descriptionstring
The more detailed description of the Tag.


Example: This is my first tag.
iconstring
Url to the icon of the tag. Ocamba will try to download and save the icon based on first item in uris array.


Example: http://ocamba.storage.com/1000000/hood/tags/1000/icons/favicon.ico
idstring
The ID of the Tag, generated by the Ocamba.


Example: 1000
namestring
The name of the tag, provided by the client.


Example: Demo Tag
settingsobject
Different tags need different configurations and settings. You can change your settings for the Hood Tag, including General settings...
Name
Description
generalobject
General settings.
Name
Description
analyticsboolean



Example: true

Default: true
consentboolean



Example: true

Default: true
crashlyticsboolean



Example: true

Default: true
include_subdomainsboolean



Example: true

Default: true
pushboolean



Example: true

Default: true
webobject
Web settings.
Name
Description
push_keystring



Example: KKV4lql8gxn0lC6NLiLWMSgGq9Orq7ZVYsbbspNlNthspH_Uul5DzG9nx_zUvRiCvox8bLfhvjYbqWfDv9iqbLze
statsobject
Shows additional statistic information about tag.
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
The status of the tag. Statuses inactive, pending and disabled are deprecated and will be removed in the future. Prefer using active, verification, rejected or paused.


Example: active

Possible values: active verification rejected paused inactive pending disabled

Default: active
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
utm_htstring
The utm_ht is UTM Hood Tracher, generated by the Ocamba.


Example: NjY4bL60NobpWTQ2O94xNDY4MjE0Np6l
totalinteger
A total number of items.


Example: 15

tip
1 Sortable fields are: id, account_id, name, status, create_time, update_time.
warning
1 In order to read 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=account,stats) and this kind of request will result with an error.

Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 15,
  "items": [
    {
      "id": "1000",
      "company_id": "1000000",
      "account_id": "1000001",
      "account": {
        "id": "1000001",
        "status": "active",
        "configured_status": "active",
        "name": "Demo Account",
        "image": "https://path/logo.jpeg"
      },
      "creator_id": "1000002",
      "name": "Demo Tag",
      "status": "active",
      "apps": {
        "web": [
          "ocamba.com"
        ],
        "android": [
          "com.Ocamba.demo"
        ],
        "ios": [
          "com.ocamba.iosdemo"
        ]
      },
      "icon": "http://ocamba.storage.com/1000000/hood/tags/1000/icons/favicon.ico",
      "utm_ht": "NjY4bL60NobpWTQ2O94xNDY4MjE0Np6l",
      "settings": {
        "general": {
          "include_subdomains": true,
          "analytics": true,
          "crashlytics": true,
          "push": true,
          "consent": true
        },
        "web": {
          "push_key": "KKV4lql8gxn0lC6NLiLWMSgGq9Orq7ZVYsbbspNlNthspH_Uul5DzG9nx_zUvRiCvox8bLfhvjYbqWfDv9iqbLze"
        }
      },
      "description": "This is my first tag.",
      "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"
    }
  ]
}