Getting Started

The Contentsquare Metrics API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. All API requests must be made over HTTPS.

Not a developer? Contact your CSM. They will direct you to the best solution to meet your data needs, whether it’s connectors (such as Google Data Studio or Reeport) or the help of the Professional Services team at Contentsquare.

  • Base URL of the API: https://api.{cloud}
  • Current Version of the API: 1.0

Contentsquare is a next-gen Analytics tool that helps you understand how and why your users are interacting with your app, mobile and websites.

To understand the metrics exposed by the API Metrics you should understand some very important concepts of Contentsquare. The metrics are obtained based on elements created and managed within the Contentsquare interface.

Defined by a name and set of pages, a mapping helps model your site by grouping together your site’s URLs into page groups. Thanks to multiple mappings of varying granularity, you can analyze your site at a macro and micro level.

Contentsquare’s Mappings are organized into URLs which are sorted in different “page groups” and the “page groups” are grouped under different categories.

More information here

Contentsquare’s page groups allow you to gather and group one or several URLs of the same type. By type we mean a set of pages of your website that share the same template and function. E.g. Product pages, List pages, etc.

Gathering URLs into “buckets” is the easiest way to analyze your website according to different levels of granularity.

More information here

The Zoning Analysis module allows you to analyze visitors’ in-page navigation. You can differentiate clickable areas on the page, called “zones”. Zoning Analysis has a large range of metrics so as to provide the most accurate and deepest in-page analysis. This way, you can determine what zones bring navigation anomalies and should be changed or moved.

You can perform your analysis with segment or goals.

Zonings split your page groups into zones. The definition of zones is based on the div of your HTML code.

You can create multiple zonings for the same page group.

See Zonings, Zones, Zone Metrics Endpoints.

Learn more about the Zoning feature on the Help Center.

A Goal is a navigation event collected by the tag.

A goal can be one of three types:

  • A page view
  • A select a zone
  • A hover over a zone

More information here

Segments help you to divide visitors into homogeneous population groups based on behaviors. A segment can be composed of:

  • Conditions tied to visitors’ context (location, technology used, language, etc.)
  • Conditions tied to visitors’ intention (behaviors, visit time, page viewed, etc.)

More information here