View count of Users

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

Retrieves a number of users

query Parameters
Arrow
Name
Description
container_idstring
Unique Container identifier. Maximum 10 characters. Must be numeric.


Example: 12345
tag_idstring
Unique Container identifier. Maximum 10 characters. Must be numeric.


Example: 12345
client_idstring
Unique Client identifier. Must be 20 characters in length. Must be numeric.


Example: 19023131319393903000
country_codestring
ISO 3166 2 character country code. Must be 2 characters in length.


Example: RS
user_langstring
Unique language indetifier. Must be 2 characters in length.


Example: en
os_idstring
Unique Operating system identifier. Up to 3 characters in length. Must be numeric.


Example: 12
browser_idstring
Unique Browser identifier. Up to 3 characters in length. Must be numeric.


Example: 6
app_namestring
App name. Up to 100 characters in length.


Example: myapp.site.com
remote_user_idstring
Unique remote user identifier. Up to 36 characters in length.


Example: afa63d73-937a-4ba7-981c-f8c22aef856a
regionstring
Unique Region identifier. Up to 10 characters in length. Must be numeric.


Example: 12414123
account_idstring
Unique Account identifier. Up to 10 characters in length. Must be numeric.


Example: 6197120
container_group_idstring
Unique Container group identifier. Up to 10 characters in length. Must be numeric.


Example: 2930
application_group_idstring
Unique Application group identifier. Up to 10 characters in length. Must be numeric.


Example: 1220
user_age.tostring
User age maximum age in age. Up to 2 characters in length. Must be numeric.


Example: 12
user_age.fromstring
User age minimum age in days. Up to 2 characters in length. Must be numeric.


Example: 3
user_data.*string
User data key value pairing. Star (*) represents the key for user data, while parameter value is the value for the * key. Value of the param is . Up to 10 characters in length. Must be numeric.


Example: 12414123
segment_idstring
Unique Segment identifier. Up to 10 characters in length. Must be numeric.


Example: 2930
Response status codes
Arrow
200 - OK
Arrow
Name
Description
totalnumber (integer)
Total number of subscribed users matching the filters.


Example: 7058
note
1 The endpoint will return a number of subscribed users only. Unsubscribed users will not be taken into account.
2 The database which stores the users for this endpoint is updated every 4 hours.
3 Fields container_id and tag_id are interchangeable, but it is recommended to use container_id since tag_id will soon be deprecated.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
 "total": 7058
}

{
  "total": 7058
}