Conductor Monitoring Reporting API v1.0 (Legacy)

The Reporting API v1.0 is unsupported. It receives no new endpoints or fields and will be sunsetted. This article is published only to help you migrate to the Reporting API v2.0 — do not build new integrations against it.

This support article covers the legacy Reporting API v1.0. While the legacy Reporting API v1.0 remains available at this moment, it does not support new endpoints and will likely be sunsetted in the future. Therefore we highly recommend using the Reporting API v2.0. If you are already using the Reporting API v1.0, we recommend you to migrate to v2.0 using the migration guide below. Our Reporting API is used for extracting data and metrics from your Conductor Monitoring account. Typical use-cases include connecting several software solutions together to streamline your reporting tasks and integrating Conductor Monitoring in your client portal.

Migration guide

This guide will help you migrate from the legacy Reporting API v1.0 to the Reporting API v2.0.

Response shape

The payload in the response body has been moved one level lower at all endpoints, under the key data. <payload> is moved to:

{  
    "data": <payload>  
}

Endpoints mapping

All request variables (e.g. <website_id>) are now passed as regular query parameters (e.g. ?website_id=<website_id>).

V2.0 endpoint	V1.0 endpoint
Entities
/v2/entities/segments	/v1/websites/`<website_id>`/segments
/v2/entities/websites	/v1/websites
Data
/v2/data/affected_page	/v1/websites/`<website_id>`/issues/`<issue>`/pages
/v2/data/issues	/v1/websites/`<website_id>`/issues
/v2/data/page	/v1/websites/`<website_id>`/pages?url=`<url>`
/v2/data/pages	/v1/websites/`<website_id>`/pages/list
/v2/data/statistics	/v1/websites/`<website_id>`/statistics/
Alerts
/v2/alerts	/v1/websites/`<website_id>`/alerts
/v2/alerts/alert_pages	/v1/websites/`<website_id>`/alerts/`<alert_id>`/pages

Supported parameters

V2.0 endpoint	Required parameters	Optional parameters
Entities
/v2/entities/segments	website_id	-
/v2/entities/websites	-	-
Data
/v2/data/affected_pages	website_id, issue, page, per_page	-
/v2/data/issues	website_id	-
/v2/data/page	website_id, url	-
/v2/data/pages	website_id, page, per_page, sort, direction	filter[segment]
/v2/data/statistics	website_id	scope
Alerts
/v2/alerts	website_id	scope
/v2/alerts/alert_pages	website_id, alert_id, page, per_page	scope

Reporting API Terms of Use

By using the Reporting API you agree to the Terms of Use.

Retrieving your Reporting API token

To use the Reporting API you need to get your Conductor Monitoring account’s Reporting API token. You’ll find it in the Account section, under the Integration tokens tab.

API request headers

When making a request you need to send along the following request headers:

Authorization: token  
Content-Type: application/json

Note: you need to provide the string “token” followed by a space and your actual API token.

Reporting API URL

Conductor Monitoring Reporting API is available on this URL.

https://api.cm.conductor.com/

Pagination

page and per_page are pagination controls — they select a slice of the result set, not the web pages an endpoint returns.

Every paginated v1.0 endpoint — pages/list, alerts//pages and issues//pages — requires both. Omitting either returns 400 invalid_payload naming the missing field.

Endpoint reference

These endpoint pages document an unsupported API. They exist so you can compare a v1.0 request against its v2.0 replacement while migrating — see the endpoints mapping above.

Reporting API v1.0 Playground

The interactive v1.0 reference, for migration purposes only.

List websites - GET /v1/websites
Inspect a URL - GET /v1/inspect_url
List segments for a website - GET /v1/websites/{website_id}/segments
Get statistics for a website - GET /v1/websites/{website_id}/statistics
Get page data - GET /v1/websites/{website_id}/pages
List pages for a website - GET /v1/websites/{website_id}/pages/list
List alerts for a website - GET /v1/websites/{website_id}/alerts
List pages for an alert - GET /v1/websites/{website_id}/alerts/{alert_id}/pages
List issues for a website - GET /v1/websites/{website_id}/issues
List pages for an issue - GET /v1/websites/{website_id}/issues/{issue_name}/pages

Endpoints with no v2.0 equivalent

These two exist only in v1.0. If you depend on either, get in touch before migrating.

Get metrics for a website - GET /v1/websites/{website_id}/metrics
Get Google Data Studio data - POST /v1/websites/{website_id}/gds

Common API errors

Every endpoint shares the same error responses. Each endpoint page lists them in full, with example payloads, under the response status tabs.

Status	Meaning
`401`	Authorization missing, or authentication failed because the token is expired or invalid
`403`	Reporting API Terms of Use not accepted, or the request was blocked
`404`	Website, scope, or URL not found
`422`	`Authorization` header malformed — the value must be `token`, a space, then your token
`429`	Rate limit exceeded: 6 requests/second/requester IP address, returned for 1 minute

Need some help with the Reporting API?

If you or your developer need any help migrating to v2.0, don’t hesitate to reach out. We’re always happy to help!

​Migration guide

​Response shape

​Endpoints mapping

​Supported parameters

​Reporting API Terms of Use

​Retrieving your Reporting API token

​API request headers

​Reporting API URL

​Pagination

​Endpoint reference

Reporting API v1.0 Playground

​Endpoints with no v2.0 equivalent

​Common API errors

​Need some help with the Reporting API?

Migration guide

Response shape

Endpoints mapping

Supported parameters

Reporting API Terms of Use

Retrieving your Reporting API token

API request headers

Reporting API URL

Pagination

Endpoint reference

Endpoints with no v2.0 equivalent

Common API errors

Need some help with the Reporting API?