O/D Analysis

Analysis Accepting

Important Note
Explore ready-to-use traffic reports and data visualizations immediately by signing up for a 30-day free trial on the MOVE Portal. Once registered, you’ll receive an API key to start using the Traffic Analytics APIs right away. Alternatively, you may contact our Sales team for a tailored solution.

Purpose

Accept an analysis by sending a POST request.

An analysis can be accepted only from the ENDED status, and accepting it moves it to ACCEPTED. Accepting consumes the analysis against the limits granted to your contract; the results of the analysis become available to you at this point. The request has no body and a successful response has no body either.

Request data

HTTPS Method: POST

For ease of viewing and identification:

  • Parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

Format

post
URL request format
https://api.tomtom.com/origindestination/1/analysis/{id}/accept?key={Your_API_Key}

Example

post
URL request example
https://api.tomtom.com/origindestination/1/analysis/512/accept?key={Your_API_Key}

Request parameters

Required parameters

Description

id
integer

Analysis number id.


Value: The analysis number id.

key
string

Authorization key for access to the API.


Value: Your valid API Key.

Response data

Errors

If there is an error in the supplied parameters or any other internal problem, an error response is generated in the requested format.

Two situations produce a 400 response:

  • The analysis is not in the ENDED status.
  • Accepting the analysis would exceed a consumable limit granted to your contract. The response names the limit.

Response codes

Code

Meaning & possible causes

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found