Get Users Data

Description

Get all values set on a specific label.

Request

URL:

CODE

https://api.engage-engine.com/v1/labels/<LABEL_ID>/users

HTTP Method: GET

Query Parameters:User

label_id:
- Description: the ID of the requested label - replace <LABEL_ID> in request URL.
- Type: int
- Required*
start_time
- Description: the start time to filter the returned users based on the create time
- Type: string - date time formatted string: YYYY-mm-dd HH:MM:ss (2020-10-25 10:01:12) - Time is set in UTC (GMT+0)
end_time
- Description: the end time to filter the returned users based on the create time
- Type: string - date time formatted string: YYYY-mm-dd HH:MM:ss (2020-10-25 10:01:12) - Time is set in UTC (GMT+0)
additional_labels
- Description: comma separated label IDs to be fetched with the main request
- Type: string - For example: 375,312
limit
- Description: Number of records to return [0 to 2500]
- Type: int
- Default value: 2500
page
- Description: The page offset of data to pull [0 to n] (until returned dataset is empty).
- Type: int -
- Default value: 0

Comment:
In case the value does not exist the variable will not be returned in the response.
Example: in case no last name was given it won’t be returned in the user object
(see scottie object example below).

Request Examples

Request:

CODE

https://api.picogp.com/v1/labels/217/users?start_time=2020-04-01 00:10:00&end_time=2020-08-21 &additional_labels=375,312&activation=1

Response

JSON

{
	"data": [
		{
			"_id": "jldfjldjkldflks45678",
			"value": "michael.jorden@nba.com",
			"user_label_id": "1546694",
			"is_dashboard_metric": false,
			"dashboard_sort_index": -1,
			"user": {
				"id": "26825002284619119",
				"first_name": "Michael",
				"last_name": "Jorden",
				"user_type": "fb",
				"date_added": "2024-01-01 15:14:02"
			},
			"additional_labels": [
				{
					"label_id": "312",
					"value": "339815000623735288",
					"name": "tt11"
				},
				{
					"label_id": "375",
					"value": "English",
					"name": "Language"
				}
			],
			"activations": [
				{
					"activation_id": 12,
					"activation_name": "Enter To Win",
					"activation_date": "2024-07-23 16:47:06",
					"campaign_id": 5,
					"campaign_name": "My Campaign"
				}
			]
		},
		{
			"id": "217",
			"value": "denis.rodman@nba.com",
			"user_label_id": "1563661",
			"is_dashboard_metric": false,
			"dashboard_sort_index": -1,
			"user": {
				"id": "4226608440698649",
				"first_name": "Denis",
				"last_name": "Rodman",
				"user_type": "fb",
				"date_added": "2024-01-07 15:18:09"
			},
			"additional_labels": [],
			"activations": [
				{
					"activation_id": 12,
					"activation_name": "My Memories",
					"activation_date": "2020-07-12 12:32:19",
					"campaign_id": 5,
					"campaign_name": "My Campaign2"
				}
			]
		},
		{
			"id": "217",
			"value": "scottie.pipen@nba.com",
			"user_label_id": "503",
			"is_dashboard_metric": false,
			"dashboard_sort_index": -1,
			"user": {
				"id": "ff1c922ed5c5d9c69d32ac7fdbb54e2c0b22da0c8f951e5d102faca58295862d",
				"first_name": "scottie",
				"user_type": "fb",
				"date_added": "2024-01-01 15:14:02"
			}
		}
	]
}