PixelSegment type
A sgement created using a tracking pixel.
Response format
A sgement created using a tracking pixel.
{
"id" : < int > ,
"name" : < string > ,
"status" : < segment_external_status > ,
"create_time" : < date > ,
"owner" : < string > ,
"pixel_id" : < integer > ,
"period_length" : < integer > ,
"times_quantity" : < integer > ,
"times_quantity_operation" : < pixel_times_quantity_operation > ,
"utm_source" : < string > ,
"utm_content" : < string > ,
"utm_campaign" : < string > ,
"utm_term" : < string > ,
"utm_medium" : < string >
}
Parameters | Description |
---|---|
id | ID of the segment. Specify this parameter when updating a segment. |
name | Segment name. |
status | Status of processing the segment. Possible values:
|
create_time | The time of segment creation. |
owner | The username of the segment owner. |
pixel_id | The pixel ID. |
period_length | The time period for tracking the user with the pixel. Acceptable values (in days): from 1 to 90 (inclusive). |
times_quantity | Threshold value (M). This is the base number for comparing how many times the user was detected by the pixel during the period. |
times_quantity_operation | Condition for including users in a pixel segment. Possible values:
|
utm_source | The utm_source tag. Can be used as a condition for including users in a pixel segment. |
utm_content | The utm_content tag. Can be used as a condition for including users in a pixel segment. |
utm_campaign | The utm_campaign tag. Can be used as a condition for including users in a pixel segment. |
utm_term | The utm_term tag. Can be used as a condition for including users in a pixel segment. |
utm_medium | The utm_medium tag. Can be used as a condition for including users in a pixel segment. |
Parameters | Description |
---|---|
id | ID of the segment. Specify this parameter when updating a segment. |
name | Segment name. |
status | Status of processing the segment. Possible values:
|
create_time | The time of segment creation. |
owner | The username of the segment owner. |
pixel_id | The pixel ID. |
period_length | The time period for tracking the user with the pixel. Acceptable values (in days): from 1 to 90 (inclusive). |
times_quantity | Threshold value (M). This is the base number for comparing how many times the user was detected by the pixel during the period. |
times_quantity_operation | Condition for including users in a pixel segment. Possible values:
|
utm_source | The utm_source tag. Can be used as a condition for including users in a pixel segment. |
utm_content | The utm_content tag. Can be used as a condition for including users in a pixel segment. |
utm_campaign | The utm_campaign tag. Can be used as a condition for including users in a pixel segment. |
utm_term | The utm_term tag. Can be used as a condition for including users in a pixel segment. |
utm_medium | The utm_medium tag. Can be used as a condition for including users in a pixel segment. |