Zone metrics
Zone Metrics Endpoints (Web)
Section titled Zone Metrics Endpoints (Web)All zone metrics
Section titled All zone metricsGET /v1/metrics/zone/{zoneId}
Returns all zone metrics between two dates
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments -
goalId integer
To return conversion metrics for a non-ecommerce goal.
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseAttractiveness rate
Section titled Attractiveness rateGET /v1/metrics/zone/{zoneId}/attractiveness-rate
The percentage of page views with at least one select the zone out of the views where the zone was displayed. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseClick rate
Section titled Click rateGET /v1/metrics/zone/{zoneId}/click-rate
The percentage of pageviews with at least one select the zone. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseClick recurrence
Section titled Click recurrenceGET /v1/metrics/zone/{zoneId}/click-recurrence
The average number of clicks on the zone, for pageviews with at least one select the zone. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseConversion Rate per Click
Section titled Conversion Rate per ClickGET /v1/metrics/zone/{zoneId}/conversion-rate-per-click
Percentage of visitors who achieved the goal after clicking on a zone. This metric allows you to determine whether interaction (click) with a zoning encourages or prevents visitors from exhibiting the goal. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments -
goalId integer
To return conversion metrics for a non-ecommerce goal.
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseConversion Rate per Hover
Section titled Conversion Rate per HoverGET /v1/metrics/zone/{zoneId}/conversion-rate-per-hover
Percentage of visitors who achieved the goal after hovering on a zone. This metric allows you to determine whether consumption (hover) of zone is contributing or detrimental to completing the goal. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments -
goalId integer
To return conversion metrics for a non-ecommerce goal.
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseEngagement Rate
Section titled Engagement RateGET /v1/metrics/zone/{zoneId}/engagement-rate
Percentage of visitors who clicked after having hovered a zone. This metric translates the affordance of an element, i.e. its capacity to define how it should be interacted with through its design. For example, the design of a CTA should make it obvious that it should be clicked. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseExposure rate
Section titled Exposure rateGET /v1/metrics/zone/{zoneId}/exposure-rate
The exposure rate takes into account the time spent on a zone. If a user scrolled through a zone very quickly, it will not be taken into account in the exposure data. A zone can only be considered “exposed” if it has been displayed for at least 150 milliseconds. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseExposure time
Section titled Exposure timeGET /v1/metrics/zone/{zoneId}/exposure-time
Time a zone was exposed. A zone can only be considered “exposed” if it has been displayed for at least 150 milliseconds. If you scroll fast from the top to the bottom of the page, the middle page will not be taken into account as the scroll movement is too fast to consider the zones in the middle have been exposed.. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseHesitation time
Section titled Hesitation timeGET /v1/metrics/zone/{zoneId}/hesitation
Average time elapsed between the last hover and the first select a zone. This metric translates whether the content is understood quickly or if users hesitate before clicking. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseHover Rate
Section titled Hover RateGET /v1/metrics/zone/{zoneId}/hover-rate
Percentage of users who hovered a zone at least once. This metric determines which zones are consumed the most. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseHover time / Float time
Section titled Hover time / Float timeGET /v1/metrics/zone/{zoneId}/hover-time
Average total time spent hovering over an element. This metric translates interest or lack of clarity, depending on the type of element. For example, a float time over 3 seconds is positive on an image or description text but is not on a CTA. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseNumber of clicks
Section titled Number of clicksGET /v1/metrics/zone/{zoneId}/number-of-clicks
The total number of clicks on the zone, for pageviews with at least one select the zone.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseRevenue
Section titled RevenueGET /v1/metrics/zone/{zoneId}/revenue
Total revenue generated by the segmented users after they clicked on an element. This metric ranks elements based on their contribution to revenue. More information regarding the metric and how to interpret it…
This metric is only accessible for “e-commerce” projects.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseRevenue per Click
Section titled Revenue per ClickGET /v1/metrics/zone/{zoneId}/revenue-per-click
Average revenue per click generated by users after they clicked on an element. This metric ranks elements based on their contribution to revenue. More information regarding the metric and how to interpret it…
This metric is only accessible for “e-commerce” projects.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseTime Before First Click
Section titled Time Before First ClickGET /v1/metrics/zone/{zoneId}/time-before-first-click
Number of seconds between page load and first select an element. This metric identifies which elements were interacted with first. More information regarding the metric and how to interpret it…
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseZone Metrics Endpoints (Apps)
Section titled Zone Metrics Endpoints (Apps)All zone metrics
Section titled All zone metricsGET /v1/metrics/zone/{zoneId}
Returns all zone metrics between two dates
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseConversion rate per tap
Section titled Conversion rate per tapGET /v1/metrics/zone/{zoneId}/conversion-rate-per-tap
Of users that tapped on the zone, the percentage that also completed the selected goal during the same session.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments -
goalId integer
To return conversion metrics for a non-ecommerce goal.
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseRevenue
Section titled RevenueGET /v1/metrics/zone/{zoneId}/revenue
Total revenue generated by users who clicked on the zone.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseRevenue per tap
Section titled Revenue per tapGET /v1/metrics/zone/{zoneId}/revenue-per-tap
Average revenue per tap generated by users after they tapped on an element.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseSwipe rate
Section titled Swipe rateGET /v1/metrics/zone/{zoneId}/swipe-rate
Percentage of users performing at least one swipe on a zone during a screen display.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseSwipe recurrence
Section titled Swipe recurrenceGET /v1/metrics/zone/{zoneId}/swipe-recurrence
Average number of times an element was swiped when engaged with during a screenview.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseTap rate
Section titled Tap rateGET /v1/metrics/zone/{zoneId}/tap-rate
Percentage of users that tapped on the zone at least once.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseTap recurrence
Section titled Tap recurrenceGET /v1/metrics/zone/{zoneId}/tap-recurrence
Average number of times an element was tapped when engaged with during a screenview.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.
Example of response
Section titled Example of responseTime before first tap
Section titled Time before first tapGET /v1/metrics/zone/{zoneId}/time-before-first-tap
Number of seconds between screen load and first tap on an element.
Query parameters
-
projectId integer
Required only for an account-level API key. The target project.
-
startDate ISO 8601 date string Required
Beginning of date range for analysis. Must be a date prior to
endDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
endDate ISO 8601 date string Required
End of date range for analysis. Must be a date after
startDate
.ISO format in UTC (e.g. “2021-08-13T12:32:40.000Z”) or with a time zone offset (e.g. “2021-08-13T12:32:40+02:00” or “2021-08-13T12:32:40%2B+02:00” when encoded in the URL).
-
device string
Device filter for analysis.
Possible values:
all
(default),desktop
,mobile
, ortablet
. -
period string
Granularity of the results. Can only be used on a date range larger then one day. It allows you to have data for each day instead of having a combine result.
Possible values: none (default),
daily
. -
segmentIds integer
Filter analysis with Contentsquare segments. Default: All visitors.
You can specify multiple segments separated by commas to retrieve the metrics for the intersection of the specified segments
Path parameters
-
zoneId integer Required
The ID of the Zone.