segmentdesc parameter

Data API / REST API / Response structure parameters rest / “segmentdesc” parameter

When your API URL contains a visitor segment (cohort), you will find in your URL a parameter that will display a description of your segment. The subset period indicates the period on which the segment is applied.

Thanks to this parameter, you can dynamically change the period of the cohort directly within the URL.
Examples:
.={p1:{R:{D:-1}}}&segment=100026916&segmentdesc={period:{D:2017-03-02}
Analysis context: Visitors who came on the site on the 2nd of March 2017 (cohort defined in “segmentdesc”) and see their action on yesterday (dataset period defined in “period”)

.={p1:{R:{D:-1}}}&segment=100026916&segmentdesc={period:{M:2017-03}}
Analysis context: Visitors who came on the site in March 2017 (cohort defined in “segmentdesc”) and see their action on yesterday (dataset period defined in “period”)

.={p1:{R:{D:-1}}}&segment=100026916&segmentdesc={period:{D:{start:'2017-06-08',end:'2017-06-10'}}}&
Analysis context: Visitors who came on the site between the the 8th & the 10th of August 2017 (cohort defined in “segmentdesc”) and see their action on yesterday (dataset period defined in “period”)

The period displayed in the “segmentdesc” parameter is different from the period defined for the entire dataset (defined in the period parameter).
For example, you can analyse the visitors who bought a product on your website last month (period of the cohort), and see if they came back last week (period of the Dataset). Or, it is also possible to have both periods identical.

Note:
The segmentdesc only works with fixed (Start/End, Day, Week, Month) and continuous periods.
The period of the visitor segment is limited to 31 days maximum.

Last update: 09/08/2017