List Segments

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

Returns a list of Segments

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
viewstring
Hood API returns full representation of the resource using the "view=full" query parameter. If not specified, the default view will be used.

Note that the "fields" parameter has precedence over the "view" parameter.


Example: view=full/default
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
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
outstring
Data format output - 'csv' (default) or 'json'.


Example: out=json
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.
idinteger
A unique identifier generated by the Ocamba.


Example: 1023
statusstring
Segment status, accepted values are inactive and active


Example: inactive
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ segment ]
An array of all created items.
Segment
Name
Description
companystring
A uniquie company identifier generated by the Ocamba.


Example: 1234321
create_timestring
Timezone: GMT.


Example: 2021-12-28 09:16:33
idstring
A unique identifier generated by the Ocamba.


Example: 1023
namestring
Segment name, maximum length 65 characters.


Example: example_segment_name
statusstring
Segment status, accepted values are inactive and active.


Example: active
targetingsegment-targeting
Targeting object.
Segment targeting
Name
Description
accountsobject

Name
Description
items[ string ]
List of account ids with unique items and minimum length of 1. This field is deprecated and will be removed in future. Please use partner as a replacement.
opstring



Example: eq

Possible values: eq | neq
application_groupsobject

Name
Description
items[ string ]
Array of hood application group ids created by the Ocamba platform.
opstring



Example: neq

Possible values: eq | neq
applicationsobject

Name
Description
items[ string ]
List of application ids with unique items and minimum length of 1. Every item should be valid full qualified domain name and can contain star (*).
opstring



Example: eq

Possible values: eq | neq
browsersobject

Name
Description
items[ string ]
Array of browser ids supported by Ocamba, max 100 items.
opstring



Example: eq

Possible values: eq | neq
containersobject

Name
Description
items[ string ]
Array of hood containers ids created on Ocamba platform, max 100 items.
opstring



Example: eq

Possible values: eq | neq
countriesobject

Name
Description
items[ string ]
Array of country codes supported by Ocamba (ISO 3166-1, 2 letter country codes), max 270 items.
opstring



Example: eq

Possible values: eq | neq
groupsobject

Name
Description
items[ string ]
Array of hood group ids created on Ocamba platform, max 100 items.
opstring



Example: eq

Possible values: eq | neq
languagesobject

Name
Description
items[ string ]
Array of language codes supported by Ocamba (ISO 639-2, 2 letter language codes), max 50 items.
opstring



Example: eq

Possible values: eq | neq
osobject

Name
Description
items[ string ]
Array of os ids supported by Ocamba, max 50 items.
opstring



Example: eq

Possible values: eq | neq
partnersobject

Name
Description
items[ string ]
List of partners ids with unique items and minimum length of 1.
opstring



Example: eq

Possible values: eq | neq
regionsobject

Name
Description
items[ string ]
Region ids.
opstring



Example: eq

Possible values: eq | neq
remote_usersobject

Name
Description
items[ string ]
Array of remote user ids maximum length of 100, tracked by Ocamba platform, max 100 items.
opstring



Example: eq

Possible values: eq | neq
subscribed_ageobject

Name
Description
fromnumber (integer)
Number in range 0-3500


Example: 10
tonumber (integer)
Number in range 1-3500. Must be greater than 'from' field.


Example: 100
tagsobject

Name
Description
items[ string ]
Array of hood tag ids created on Ocamba platform, max 100 items. This field is deprecated and will be removed in future. Please use container as a replacement.
opstring



Example: eq

Possible values: eq | neq
user_dataobject
Key value pairs {key:value}.
Name
Description
keystring
Key can be any string which represents user specific data, max 100 characters. Key will be sanitized by removing leading and trailing whitespace, replacing all consecutive non-leading and non-trailing whitespaces with a single underscore, converting all character to lowercase and using only first 100 characters if there are over 100 characters.
valueobject

Name
Description
items[ string ]
Array of values, maximum 10 items.
opstring



Example: eq

Possible values: eq | neq
usersobject

Name
Description
items[ string ]
Array of user ids tracked by Ocamba platform, max 100 items.
opstring



Example: eq

Possible values: eq | neq
totalinteger
A total number of items.


Example: 61
tip
1 Searchable field is name.
2 Sortable fields are: name, create_time and status
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
	"total": "61",
	"items": [{
			"id": "1949",
			"name": "segment_name_example",
			"status": "inactive",
			"create_time": "2022-01-19 12:53:26",
			"targeting": {									
				"countries": {
					"op": "neq",
					"items": ["DZ", "AS", "AD", "AO", "AI", "AG", "AW", "AU", "AZ"]
				},
				"languages": {
					"op": "eq",
					"items": ["nl"]
				},
				"os": {
					"op": "eq",
					"items": ["17"]
				},
				"browsers": {
					"op": "eq",
					"items": ["10"]
				},
				"apps": {
					"op": "eq",
					"items": ["811353353"]
				},
				"users": {
					"op": "eq",
					"items": ["67890"]
				},
				"groups": {
					"op": "eq",
					"items": ["1233"]
				},
				"regions": {
					"op": "eq",
					"items": ["2661876"]
				},
        "subscribed_age": {
          "from": 1,
          "to": 100
        },
				"user_data": {
					"carrier": {
						"op": "eq",
						"items": ["gcfhvjk"]
					},
					"configvariant": {
						"op": "eq",
						"items": ["ftyugi"]
					},
					"device_brand": {
						"op": "eq",
						"items": ["56789"]
					}
				},
				"remote_users": {
					"op": "eq",
					"items": ["795269c1-3d0d-49bf-b421-1ac0d8a7899d"]
				}	
			}
		}
	]
}

{
  "total": 61,
  "items": [
    {
      "id": "1023",
      "company": "1234321",
      "name": "example_segment_name",
      "status": "active",
      "targeting": {
        "countries": {
          "items": [
            "US"
          ],
          "op": "eq"
        },
        "languages": {
          "items": [
            "en"
          ],
          "op": "eq"
        },
        "os": {
          "items": [
            "4"
          ],
          "op": "eq"
        },
        "browsers": {
          "items": [
            "12"
          ],
          "op": "eq"
        },
        "tags": {
          "items": [
            "2309876112"
          ],
          "op": "eq"
        },
        "containers": {
          "items": [
            "2309876111"
          ],
          "op": "eq"
        },
        "users": {
          "items": [
            "101010"
          ],
          "op": "eq"
        },
        "groups": {
          "items": [
            "164"
          ],
          "op": "eq"
        },
        "application_groups": {
          "items": [
            "1014"
          ],
          "op": "neq"
        },
        "regions": {
          "items": [
            "2661876"
          ],
          "op": "eq"
        },
        "subscribed_age": {
          "from": 10,
          "to": 100
        },
        "user_data": {
          "value": {
            "items": [
              "foo"
            ],
            "op": "eq"
          }
        },
        "accounts": {
          "items": [
            "2661876"
          ],
          "op": "eq"
        },
        "partners": {
          "items": [
            "2661876"
          ],
          "op": "eq"
        },
        "applications": {
          "items": [
            "2661876"
          ],
          "op": "eq"
        },
        "remote_users": {
          "items": [
            "9464779a-decc-4016-8eec-d56c4e384aa5"
          ],
          "op": "eq"
        }
      },
      "create_time": "2021-12-28 09:16:33"
    }
  ]
}