PolygonGeoSegment type

Segment based on location data for polygons.

Response format

Segment based on location data for polygons.


{
    "id" :  < int > ,
    "name" :  < string > ,
    "status" :  < segment_external_status > ,
    "create_time" :  < date > ,
    "owner" :  < string > ,
    "geo_segment_type" :  < geo_segment_type > ,
    "times_quantity" :  < integer > ,
    "period_length" :  < integer > ,
    "polygons" : [ {
        "points" : [ {
            "latitude" :  < big_decimal > ,
            "longitude" :  < big_decimal > ,
            "description" :  < 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:

  • uploaded – The segment with the user's data has been uploaded.
  • is_processed – The segment with the specified parameters is being processed.
  • processed – Uploading and processing the segment is complete. The segment is ready to use.
  • processing_failed – Processing the segment failed with an error.
  • is_updated — The segment is updated.
  • few_data – The segment doesn't have enough data.
create_time The time of segment creation.
owner The username of the segment owner.
geo_segment_type Type of coordinates for creating the segment.

Possible values:

  • last — Current location. The segment will include users who are located in the selected area right now, or who were there less than an hour ago.
  • regular — Frequent location. The segment will include users who frequently visit the selected area. For example, they may be people who live or work nearby. Targeting is based on the data from the past 45 days.
  • home — Home location. The segment will include users who live in the selected area.
  • work — Work location. The segment will include users who work in the selected area.
  • condition — The condition “The user visited the specified places X times during the period”. The segment will include users who meet this criteria.
times_quantity

Frequency of visits to the specified places. This parameter is required if you are creating the condition “The user visited the specified places X times during the period”.

Note.

Only one visit per day is counted.
period_length

The period for visits to the specified places. This parameter is required if you are creating the condition “The user visited the specified places X times during the period”.

Acceptable values for the time period (in days): from 1 to 90 (inclusive).
polygons List of polygons. You cannot add more than 10 polygons to a segment.
Parameters Description
points The coordinates of the points.
Parameters Description
latitude Latitude.
longitude Longitude.
description Any comment with the length not exceeding 200.
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:

  • uploaded – The segment with the user's data has been uploaded.
  • is_processed – The segment with the specified parameters is being processed.
  • processed – Uploading and processing the segment is complete. The segment is ready to use.
  • processing_failed – Processing the segment failed with an error.
  • is_updated — The segment is updated.
  • few_data – The segment doesn't have enough data.
create_time The time of segment creation.
owner The username of the segment owner.
geo_segment_type Type of coordinates for creating the segment.

Possible values:

  • last — Current location. The segment will include users who are located in the selected area right now, or who were there less than an hour ago.
  • regular — Frequent location. The segment will include users who frequently visit the selected area. For example, they may be people who live or work nearby. Targeting is based on the data from the past 45 days.
  • home — Home location. The segment will include users who live in the selected area.
  • work — Work location. The segment will include users who work in the selected area.
  • condition — The condition “The user visited the specified places X times during the period”. The segment will include users who meet this criteria.
times_quantity

Frequency of visits to the specified places. This parameter is required if you are creating the condition “The user visited the specified places X times during the period”.

Note.

Only one visit per day is counted.
period_length

The period for visits to the specified places. This parameter is required if you are creating the condition “The user visited the specified places X times during the period”.

Acceptable values for the time period (in days): from 1 to 90 (inclusive).
polygons List of polygons. You cannot add more than 10 polygons to a segment.
Parameters Description
points The coordinates of the points.
Parameters Description
latitude Latitude.
longitude Longitude.
description Any comment with the length not exceeding 200.