Sorry, you need to enable JavaScript to visit this website.

Analysis Preview

Request

Format

https://<baseURL>/traffic/od/rest/analysis/<id>?key=<apiKey>

Required POST Headers

Content-Type: application/json

Parameters






Request parameters
parameter Description Required? Type / Values Default Value

baseURL

Base URL for calling the API.

Yes

api.tomtom.com

-

id

Analysis number id.

Yes

long

-

apiKey

Authorization key for access to the API.

Yes

API Key

-

Response

  • ❏ TODO: Opis




Structure of response (JSON)
Field(s) Description Type / Values

id

Analysis number id (from request).

(as in request)

creationTime

Job creation time.

Timestamp in format: YYYY-MM-DDTHH:mm:ss.SSSZ

status

Job status.

List of possible states:

  • WAITING

  • RUNNING

  • ENDED

  • FAILED

  • CANCELLED

statusDetails

???

String

type

Type of analysis.

String / "FLOW_MATRIX"

parameters

Parameters regarding analysis. See structure here.

List of properties:

  • time

  • regions

  • name

  • timeMode

  • timeWindow

  • separateHours

  • separateDaysOfWeek

  • pass Matrix

  • keepMidnightTraces

result

Flows & dimension. See structure here.

List of properties:

  • flows

  • dimensions

name

Job name, given for user’s convenience.

String

owner

Owner email who running this analysis.

String

startAnalysisTime

Date and time start of analysis.

Timestamp in format: YYYY-MM-DDTHH:mm:ss.SSSZ

endAnalysisTime

Date and time end of analysis.

Timestamp in format: YYYY-MM-DDTHH:mm:ss.SSSZ

currentProgress

Current value of job progress.

Integer (0-1000)

maxProgress

Maximum value of job progress.

Integer (1000)

Parameters structure




Structure of parameters
Field(s) Description Type / Values

time

Time sets used during calculations. See structure here

List of properties:

  • zoneId

  • dataRanges

  • timeRanges

  • daysOfWeek

regions

Defined regions during calculations. See structure here

List of features:

  • type

  • properties

  • geometry

(In GEO JSON format)

  • ❏ TODO: ??? (timeWindow, separateHours, separateDaysOfWeek, passMatrix, keepMidnightTraces)




Structure of result (JSON)
Field(s) Description Type / Values

flows

???

???

dimensions

???

???

  • ❏ TODO: Structure of result

Final Example

Here is example, showing correct final response
{
  "id": 0,
  "creationTime": "2018-09-19T18:00:41.740Z",
  "status": "ENDED",
  "statusDetails": string,
  "type": "FLOW_MATRIX",
  "parameters": {
    "time": {...},
    "regions": [...],
    "name": "string",
    "timeMode": "WHOLE_INSIDE",
    "timeWindow": null,
    "separateHours": false,
    "separateDaysOfWeek": false,
    "passMatrix": false,
    "keepMidnightTraces": false
  },
  "result": {
    "flows": [...]
    "dimensions": [...]
  },
  "name": "string",
  "owner": "wieprz@groups.tomtom.com",
  "startAnalysisTime": "2018-09-21T12:11:28.645Z",
  "endAnalysisTime": "2018-09-21T12:21:17.164Z",
  "currentProgress": 1000,
  "maxProgress": 1000
}

You are here