Conductor Monitoring Reporting API - Conductor Documentation

Getting Started

Overview

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.

This support article is covering the current 2.0 version of Conductor Monitoring’s Reporting API. We recommend using the Reporting API v2.0 for your reporting tasks and integrations as all new endpoints will be only supported on this version.The legacy Conductor Monitoring Reporting API version is still available. You can find the relevant support documentation and our migration guide in the Conductor Monitoring Reporting API V1.0 article.Please note that while the legacy Reporting API v1.0 remains available at the moment, it will likely be deprecated in the future. Therefore we highly recommend using (and migrating to) the Reporting API v2.0.

Reporting API Terms of Use

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

Authentication

Get your API integration token

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

Configure your request headers

To authenticate your requests, you need to include the following request headers:

Authorization: token {place-your-API-token-here}
Content-Type: application/json

The value for the Authorization header must be the string “token” followed by a space and then your actual API token.

Rate limits

The Reporting API uses rate limits to ensure API request traffic can be handled efficiently. Rate limits define the maximum number of requests which can be made in a given time range. Conductor Monitoring’s Reporting API has the following rate limits:

6 requests/second/requester IP address
When the limit is hit the API returns a 429 status code for 1 minute

Note that there is no maximum number of calls you can make to this API.

Using the Conductor Monitoring Reporting API

Base URL

Conductor Monitoring Reporting API is available on the following URL:

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

API reference and playground

Every endpoint has its own page with the full parameter list, response schema, example payloads, and an interactive Try it form you can send real requests from.

Reporting API Playground

The complete interactive reference for all 14 endpoints.

Start with List websites. Almost every other request takes a website_id, and that endpoint is where you get it.

Entities

Look up the IDs the rest of the API needs.

List websites - GET /v2/entities/websites
List segments for a website - GET /v2/entities/segments

Data

Statistics, pages, issues, and log file analysis.

Get statistics - GET /v2/data/statistics
List pages for a website - GET /v2/data/pages
Get page data - GET /v2/data/page
Get log file analysis data - GET /v2/data/page_lfa
List issues for a website - GET /v2/data/issues
List affected pages for an issue - GET /v2/data/affected_pages
Get page issue details - GET /v2/data/page/issues
Get page broken links - GET /v2/data/page/issues/broken_links
Get page redirected links - GET /v2/data/page/redirected_links
Get page canonicalized links - GET /v2/data/page/issues/canonicalized_links

Alerts

List alerts for a website - GET /v2/alerts
List pages for an alert - GET /v2/alerts/alert_pages

Scoping requests to a website or segment

The statistics and issues endpoints take a scope parameter, which accepts three forms:

Scope	Meaning
`website`	The whole website
`segment:{id}`	One segment, by ID from List segments
`segment_label:{label}`	One segment, by its label — for example `segment_label:Important pages`

Paginating large result sets

page and per_page are pagination controls — they select a slice of the result set. They have nothing to do with the web pages an endpoint returns. On an endpoint like List pages for an alert, per_page is how many result rows come back per request, not how many of your site’s pages are affected.

Most paginated endpoints require both page and per_page. Omitting either returns 400 invalid_payload naming the field you left out:

{
  "code": "invalid_payload",
  "message": "Invalid data sent.",
  "errors": [{ "message": "Value is missing required fields", "missing_fields": ["page"] }]
}

Endpoint	`page`	`per_page`
List pages for a website	Optional	Required
List affected pages for an issue	Required	Required
List pages for an alert	Required	Required
Broken, redirected and canonicalized links	n/a	Optional

For sites with 10,000 or more pages, use page_cursor rather than page. Pass the next_page_cursor value from the previous response to get the next batch; it is faster and more reliable than numbered pages. page_cursor takes precedence over page, so don’t send both.

Need some help with the Reporting API?

If you or your developer need any help integrating the API, don’t hesitate to reach out. We’re always happy to help!

​Getting Started

​Overview

​Reporting API Terms of Use

​Authentication

​Get your API integration token

​Configure your request headers

​Rate limits

​Using the Conductor Monitoring Reporting API

​Base URL

​API reference and playground

Reporting API Playground

​Entities

​Data

​Alerts

​Scoping requests to a website or segment

​Paginating large result sets

​Need some help with the Reporting API?

Getting Started

Overview

Reporting API Terms of Use

Authentication

Get your API integration token

Configure your request headers

Rate limits

Using the Conductor Monitoring Reporting API

Base URL

API reference and playground

Entities

Data

Alerts

Scoping requests to a website or segment

Paginating large result sets

Need some help with the Reporting API?