Skip to main content
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:

Endpoints mapping

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

Supported parameters

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:
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.

Retrieving a list of websites in your account

Send the following request to get a list of websites in your account:
The response will look like this:
Data types overview for this endpoint

Retrieving a list of segments for a website

Send the following request to get a list of segments for a specific website in your account:
The response will look like this:
Data types overview for this endpoint

Retrieving statistics for a website or website’s segment

Send the following request to get statistics for a specific website in your account:
Or send the following request to get statistics for a specific segment within the website:
The response will look like this:
Data types overview for this endpoint

Specific errors when requesting statistics

This response means that the statistics for the given scope (website or segment) are not available at this time. They may or may not become available at a later time.

Retrieving list of pages for a website

Send the following request to get list of pages for a specific website:

Pagination

Query parameters per_page and page are used for iterating over large result sets.
  • per_page can be in range from 1 to 500
  • page can be 1 up to ceil(total / per_page). If page is higher than max value the urls field will be an empty array

Response

Each API response contains 2 main keys:
  • total count of urls in result set for given query
  • urls paginated urls based on query parameters per_page and page
Data types overview for this endpoint

Retrieving data for a specific page within a website

Send the following request to get data for a specific page within a website in your account:

Response for a page

The response for an existing page (URL returns HTTP status 200) will look like this:

Response for a redirect

The response for a redirect (URL returns HTTP status 3xx) will look like this:

Response for missing

The response for a missing page (URL returns HTTP status 4xx) will look like this:
Data types overview for this endpoint

Specific errors when requesting page data

This response means that the URL passed in the request is not monitored by Conductor Monitoring.
This response means that data for the URL passed in the request is not available via the Reporting API.

Retrieving a list of alerts for a website

Send the following request to get a list of alerts for a specific website in your account:
The response will look like this:
Data types overview for this endpoint

Retrieving list of pages for a website alert

Send the following request to get list of pages for a specific website alert:

Pagination

Query parameters per_page and page are used for iterating over large result sets.
  • per_page can be in range from 1 to 500
  • page can be 1 up to ceil(total / per_page). If page is higher than max value the urls field will be an empty array

Response for a page

Each API response contains 2 main keys:
  • total count of urls in result set for given query
  • urls paginated urls based on query parameters per_page and page
Data types overview for this endpoint

Retrieving a list of issues for a website

Send the following request to get a list of issues for a specific website in your account:
The response will look like this:
Data types overview for this endpoint

Retrieving list of pages for a website issue

Send the following request to get list of pages for a specific website issue:

Pagination

Query parameters per_page and page are used for iterating over large result sets.
  • per_page can be in range from 1 to 500
  • page can be 1 up to ceil(total / per_page). If page is higher than max value the urls field will be an empty array

Response for a page

Each API response contains 2 main keys:
  • total count of urls in result set for given query
  • urls paginated urls based on query parameters per_page and page

List of issues

Common API errors

Authorization missing

This response means that the request was received, but that it’s lacking an authorization token and can therefore not be processed. Make sure to correctly set the Authorization header.

Authorization failed

If you get this response it means that the request could not be processed because the supplied API token is invalid or expired.

Reporting API Terms of Use not accepted

If you get this response it means that you have not accepted Reporting API Terms of Use yet. You need to accept them in Account Settings before you start using Reporting API.

Website not found

In case you get this response the website ID you specified can’t be found in your account.

Authorization malformed

This response means that the request was received, but that the authorization wasn’t formatted correctly. Make sure to correctly set the Authorization header.

Rate limits

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
The Reporting API uses rate limits to ensure API request traffic can be handled efficiently.