View Tag

View Tag

GET https://api.ocamba.com/v1/hood/tags/{id}

Retrieves the details of a Tag that has previously been created if a valid identifier was provided

Rate limits:

Burst: 10/s
Steady: 150/m

Path parameters

parameters

Query parameters

parameters

Response schemas

GET https://api.ocamba.com/v1/hood/tags/{id} HTTP/1.1
Host: api.ocamba.com
Authorization: Bearer YOUR_SECRET_TOKEN
curl -X GET "https://api.ocamba.com/v1/hood/tags/{id}" \
  -H "Authorization: Bearer $TOKEN"
fetch("https://api.ocamba.com/v1/hood/tags/{id}", {
  method: "GET",
  headers: { Authorization: `Bearer ${TOKEN}` }
}).then(r => r.json());
$ch = curl_init("https://api.ocamba.com/v1/hood/tags/{id}");
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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "total": 1,
  "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"
    }
  ]
}
Responses

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.