{"info":{"_postman_id":"6fcf7d66-641e-4bfc-b011-02b492422994","name":"ATLYST API Doc v0.2.1","description":"

For the Latest ATLYST API Documentation please visit: https://documenter.getpostman.com/view/26157408/2s946eAtLY

Authentication

To get access to the ATLYST API you will require an API key, please contact atlyst@metrocount.com to request a key for your organisation.

The key must be passed in the header of all requests as \"APIKEY\" : \"keystring\"

Python Examples API Usage with Requests Library

import requests\nheaders = {\"APIKEY\": \"your api key\"}\n# get all site list in json response\nsite_list_url = \"https://atlyst.metrocount.com/api/list_sites/\"\nsite_list_request = requests.post(site_list_url, headers=headers)\n# get the json response with all sites\nsite_list_response = site_list_request.json()\n# get the interval statistics for the first site in site list response\ninterval_stats_url = \"https://atlyst.metrocount.com/api/interval_site_statistics/\"\nfirst_site_id = site_list_response[0][\"site_id\"]\ninterval_stats_request_body = {\"site_id\": first_site_id}\n# get the interval statistics for the first site in site list response\nrequest_interval_stats = requests.post(interval_stats_url, headers=headers, data=interval_stats_request_body)\nprint(request_interval_stats.json())\n\n

Querying Individual Vehicles Code Example

from dateutil.parser import parse\nimport requests\n# IMPORTANT: declare start_timestamp and end_timestamp both in UTC\nstart_timestamp = '2019-07-01T00:00:00+00:00'\nend_timestamp = '2019-08-01T00:00:00+00:00'\n# parse to Python datetime for comparison\nstart_dt = parse(start_timestamp)\nend_dt = parse(end_timestamp)\n# create requests variables\nheaders = {\"APIKEY\": apikey}\nind_veh_url = \"https://metrocount.io/api/individual_vehicles/\"\n# initialise loop variables\nlast_dt = start_dt\nveh_counts = 0\nlast_timestamp = start_timestamp\nwhile last_dt < end_dt:\n    # compose the requested data body\n    print(f\"Query vehicles from timestamp {last_timestamp}\")\n    body = {\n        \"site_id\":5541,\n        \"start_timestamp\": last_timestamp,\n        'limit':100000\n    }\n    # make the request\n    ind_veh_request = requests.post(ind_veh_url, headers=headers, data=body)\n    cur_data = ind_veh_request.json()[\"data\"]\n    # stop the loop if no more data is available\n    if not cur_data:\n        break\n    data_len = len(cur_data)\n    print(f\"Retrieved {data_len} records\")\n    veh_counts += data_len\n    last_timestamp = cur_data[-1][0] # use the timestamp(UTC) as the new query params\n    last_dt = parse(last_timestamp) # update the last_dt for loop comparison\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"2950534","collectionId":"6fcf7d66-641e-4bfc-b011-02b492422994","publishedId":"TVYGbd3H","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"001D33","highlight":"005BBD"},"publishDate":"2021-03-03T06:33:41.000Z"},"item":[{"name":"list_sites","id":"1bb2d378-34ef-4b91-9b64-d535befd90b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"APIKEY","type":"text","value":"contact atlyst@metrocount.com"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://atlyst.metrocount.com/api/list_sites/","description":"

List all sites

Params:

None

Response:

site_id: INT | Unique site id, required for further requests.
name: STRING | Site name
description: STRING | Site description
asset_management_id: STRING | Asset management id
latitude: FLOAT
longitude: FLOAT
class_scheme_name: STRING | Vehicle classification scheme applied at site
classifications: List of vehicle classes in the class_scheme, class_index can be used to filter statistics queries
survey_periods: [{start_time: STRING, end_time: STRING}] | List of date ranges where data is available. Use this to determine the start_time, end_time period for the interval_statistics. For temporary site, each survey period will contribute to one element in the array. For permanent site, it will normally have one element in the array, and the end_time for the survey_period will keep updated when new data comes in.

Example Response:

[\n    {\n        \"site_id\": 19847,\n        \"name\": \"Thomas Street\",\n        \"description\": \"Thomas St - btw Michael St & Patrick St\",\n        \"latitude\": \"-31.980281\",\n        \"longitude\": \"115.874232\",\n        \"asset_management_id\": \"001 20309\",\n        \"class_scheme_name\": \"VRX\",\n        \"survey_periods\": [\n            {\n                \"start_time\": \"2018-03-27T02:58:00Z\",\n                \"end_time\": \"2018-04-03T22:11:00Z\"\n            }\n        ],\n        \"classifications\": [\n            {\n                \"class_index\": 15,\n                \"name\": \"CYCLE\"\n            },\n            {\n                \"class_index\": 14,\n                \"name\": \"M/C\"\n            },\n            {\n                \"class_index\": 13,\n                \"name\": \"???\"\n            },\n            {\n                \"class_index\": 12,\n                \"name\": \"TRT\"\n            },\n            {\n                \"class_index\": 11,\n                \"name\": \"DRT\"\n            },\n            {\n                \"class_index\": 10,\n                \"name\": \"BD\"\n            },\n            {\n                \"class_index\": 9,\n                \"name\": \"ART6\"\n            },\n            {\n                \"class_index\": 8,\n                \"name\": \"ART5\"\n            },\n            {\n                \"class_index\": 7,\n                \"name\": \"ART4\"\n            },\n            {\n                \"class_index\": 6,\n                \"name\": \"ART3\"\n            },\n            {\n                \"class_index\": 5,\n                \"name\": \"T4 \"\n            },\n            {\n                \"class_index\": 4,\n                \"name\": \"TB3\"\n            },\n            {\n                \"class_index\": 3,\n                \"name\": \"TB2\"\n            },\n            {\n                \"class_index\": 2,\n                \"name\": \"SVT\"\n            },\n            {\n                \"class_index\": 1,\n                \"name\": \"SV \"\n            },\n            {\n                \"class_index\": 0,\n                \"name\": \"AR0\"\n            }\n        ]\n    }]\n

","urlObject":{"protocol":"https","path":["api","list_sites",""],"host":["atlyst","metrocount","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1bb2d378-34ef-4b91-9b64-d535befd90b5"},{"name":"interval_site_statistics","id":"5ef89431-e112-44bf-9b8a-8659f4094689","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"APIKEY","value":"Contact MetroCount","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_ids\": [\n 19866\n ],\n \"start_time\": \"2023-02-20T00:00\",\n \"end_time\": \"2023-02-27T00:00\",\n \"velocity_min\": 0,\n \"velocity_max\": 1000,\n \"interval\": \"15min\",\n \"min_headway\": 4,\n \"speed_unit\": \"kmh\"\n}","options":{"raw":{"language":"json"}}},"url":"https://atlyst.metrocount.com/api/interval_site_statistics/","description":"

Retrieve interval statistics for a site

Retrieve statistics for a site over a given time period. The max range for a single request is:

10 days at \"15min\" interval
\n
60 days for all other intervals
\n

Null values

Where there are no vehicles in an interval (ie if the data is out of range) an empty interval will be included, unless the fill_nulls parameter is set to false.

eg.

{\n  \"volume\": 0,\n  \"the_85th\": null,\n  \"the_99th\": null,\n  \"timeslot\": \"2018-03-27T14:00:00\",\n  \"avg_speed\": null,\n  \"heading\": \"East\",\n  \"heading_code\": 3\n},\n\n

Params:

site_ids (Required): [INTEGER]: site_id's to get interval statistics from.
\n
start_time (Optional): STRING| Naive Timestamp (local time), formatted as \"YYYY-mm-ddTHH:MM\", and will default to now() in your default timezone minus 1 hour if no value is provided, example: \"2021-03-16T00:00\"
\n
end_time (Optional): STRING | Naive Timestamp (local time), formatted as \"YYYY-mm-ddTHH:MM\", default now() in your default timezone if no value is provided, example: \"2016-03-17T00:00\"
\n
velocity_min (Optional): INTEGER | default 0, min speed in meters/second
\n
velocity_max (Optional): INTEGER | default 100, max speed in meters/second
\n
min_headway (Optional): INTEGER | default 0, minimum gap between vehicles
\n
interval (Optional): STRING | default \"15min\", one of ['5min','15min','30min','1hour','1day']
\n
included_classes (Optional): [INTEGER] | vehicle class indexes to include, defaulting to all classes if no value is provided.
\n
speed_units (Optional): STRING | default to m/s if nothing passed, one of [\"kmh\", \"mph\"]
\n
fill_nulls (Optional): bool | default true, will return empty data points where there is no data.
\n
utc_time (Optional): bool | default false, format returned timeslots in UTC.
\n

Response:

site_id: INT | Unique site id, required for further requests.
\n
name: STRING | Site name
\n
description: STRING | site description
\n
asset_management_id: STRING | Asset management id
\n
latitude: FLOAT
\n
longitude: FLOAT
\n
class_scheme_name: STRING | the class_scheme applied to this site
\n
heading: STRING | one of [\"East/West\", \"South/North\"]
\n
stats
\n
- timeslot: STRING | timestamp in local time for start of interval
  \n
- volume: INTEGER | count of vehicles for interval
  \n
- avg_speed: FLOAT | average speed in m/s
  \n
- the_99th: FLOAT | 85th percentile speed in m/s
  \n
- the_85th: FLOAT | 85th percentile speed in m/s
  \n
- heading: String | East/West/South/North/All
  \n
- heading_code INTEGER | All => -1, North => 1, East => 3, South => 5, North => 7
  \n
\n

Example Response:

[\n    {\n        \"site_id\": 19847,\n        \"name\": \"Thomas Street\",\n        \"description\": \"Thomas St - btw Michael St & Patrick St\",\n        \"latitude\": \"-31.980281\",\n        \"longitude\": \"115.874232\",\n        \"class_scheme\": \"VRX\",\n        \"heading\": \"East/West\",\n        \"north_or_east_stats\": [\n            {\n                \"volume\": 3,\n                \"the_85th\": 12.53,\n                \"the_99th\": 12.63,\n                \"timeslot\": \"2018-03-27T14:00:00\",\n                \"avg_speed\": 11.5,\n                \"heading\": \"All\",\n                \"heading_code\": -1,\n            },\n            {\n                \"volume\": 0,\n                \"the_85th\": null,\n                \"the_99th\": null,\n                \"timeslot\": \"2018-03-27T14:15:00\",\n                \"avg_speed\": null,\n                \"heading\": \"East\",\n                \"heading_code\": 3,\n            }\n        ],\n        \"south_or_west_stats\": [\n            {\n                \"volume\": 1,\n                \"the_85th\": 4.47,\n                \"the_99th\": 4.47,\n                \"timeslot\": \"2018-03-27T14:00:00\",\n                \"avg_speed\": 4.5,\n                \"heading\": \"West\",\n                \"heading_code\": 7,\n            },\n            {\n                \"volume\": 4,\n                \"the_85th\": 11.41,\n                \"the_99th\": 12.61,\n                \"timeslot\": \"2018-03-27T14:15:00\",\n                \"avg_speed\": 8.7,\n                \"heading\": \"East\",\n                \"heading_code\": 3,\n            }\n        ]\n    }\n]\n\n

","urlObject":{"protocol":"https","path":["api","interval_site_statistics",""],"host":["atlyst","metrocount","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ef89431-e112-44bf-9b8a-8659f4094689"},{"name":"site_survey_statistics","id":"c52b7366-40df-4883-ae8c-dff2902a3249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"APIKEY","value":"Contact MetroCount","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_ids\": [\n 19866\n ],\n \"start\": \"2010-01-01\",\n \"end\": \"2026-01-01\",\n \"latest_survey\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://atlyst.metrocount.com/api/site_survey_statistics/","description":"

Retrieve Survey statistics for a site

Retrieve statistics per survey for a list of sites over a given time period.

Params:

site_ids (Required): [INTEGER]: site_id's to get interval statistics from.
start_time (Required): STRING| Naive Timestamp (local time), formatted as \"YYYY-mm-ddTHH:MM\", and will default to now() in your default timezone minus 1 hour if no value is provided, example: \"2021-03-16T00:00\"
end_time (Required): STRING | Naive Timestamp (local time), formatted as \"YYYY-mm-ddTHH:MM\", default now() in your default timezone if no value is provided, example: \"2016-03-17T00:00\"
latest_survey (Required): BOOLEAN, true or false. If set to true, only the latest survey of each site will be included. Otherwise it is all surveys within the start-end time period.

Response:

Response is a list of survey results, each survey within each site will return an individual JSON object.

site_id: INT | Unique site id, required for further requests.
name: STRING | Site name
description: STRING | site description
asset_management_id: STRING | Asset management id
latitude: FLOAT
longitude: FLOAT
class_scheme_name: STRING | the class_scheme applied to this site
heading: STRING | one of [\"East/West\", \"South/North\"]
start_time: the start time of this survey
end_time: the end time of this survey
combined_heading_stats/north_or_east_stats/south_or_west_stats: stats combines all headings in this survey, or specific direction stats
- per_class_vol: ARRAY of OBJECTS | total volume per class, each object includes a class ID, a class name, and its total volume.
- adt: FLOAT | average daily traffic
- awdt: FLOAT | weekday average daily traffic
- awedt: FLOAT | weekend average daily traffic
- the_85th: FLOAT | 85th percentile speed
- the_85th_we: FLOAT | weekend 85th percentile speed
- the_85th_wd: FLOAT | weekday 85th percentile speed
- avg_speed: FLOAT | average speed
- avg_speed_we: FLOAT | weekend average speed
- avg_speed_wd: FLOAT | weekday average speed
- perc_light: FLOAT | percentage light vehicles
- perc_medium: FLOAT | percentage medium vehicles
- perc_heavy: FLOAT | percentage heavy vehicles
- perc_cycle: FLOAT | percentage cycle
- perc_motorcycle: FLOAT | percentage motorcycle
- perc_unclassifiable: FLOAT | percentage unclassifiable vehicles
- class_ind_adt: ARRAY[21] of INTEGER | average daily traffic of each class, the position in the array corresponds to the class ID in per_class_vol. The array always has 21 elements, the extra elements will always have value zero.
- class_ind_awedt: ARRAY[21] of INTEGER | weekend average daily traffic of each class
- class_ind_awdt: ARRAY[21] of INTEGER | weekday average daily traffic of each class
- class_scheme_name: STRING | name of vehicle classification scheme
- speed_limit: FLOAT | speed limit, in m/s
- speed_diff: FLOAT | difference for the speed limit with the 85th speed, in m/s
- virtual_days: OBJECT | virtual day data, including weekday(WD), weekend(WE), week(WK)
  - am_peak_hour_vol: INTEGER | AM peak hour volume
  - pm_peak_hour_vol: INTEGER | PM peak hour volume
  - am_peak_hour: STRING | AM peak hour timespan
  - pm_peak_hour: STRING | PM peak hour timespan
  - hourly_vol : OBJECT | key is timespan, value is the virtual hour volume
  \n
\n

Example Parameters:

{\n    \"site_ids\": [\n        19866\n    ],\n    \"start\": \"2010-01-01\",\n    \"end\": \"2026-01-01\",\n    \"latest_survey\": true\n}\n\n

Example Response:

[\n    {\n        \"site_id\": 19866,\n        \"name\": \"Gladstone-02\",\n        \"description\": \" Gladstone Ave - btw Jameson St & Shaftesbury St\",\n        \"asset_management_id\": null,\n        \"latitude\": -31.980297,\n        \"longitude\": 115.874228,\n        \"class_scheme\": \"VRX\",\n        \"heading\": \"East/West\",\n        \"start_time\": \"2018-03-27T02:58:00+0800\",\n        \"end_time\": \"2018-04-03T22:11:00+0800\",\n        \"combined_heading_stats\": {\n            \"per_class_adt\": [\n                {\n                    \"class\": 0,\n                    \"name\": \"AR0\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 1,\n                    \"name\": \"SV \",\n                    \"adt\": 1195\n                },\n                {\n                    \"class\": 2,\n                    \"name\": \"SVT\",\n                    \"adt\": 10\n                },\n                {\n                    \"class\": 3,\n                    \"name\": \"TB2\",\n                    \"adt\": 23\n                },\n                {\n                    \"class\": 4,\n                    \"name\": \"TB3\",\n                    \"adt\": 4\n                },\n                {\n                    \"class\": 5,\n                    \"name\": \"T4 \",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 6,\n                    \"name\": \"ART3\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 7,\n                    \"name\": \"ART4\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 8,\n                    \"name\": \"ART5\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 9,\n                    \"name\": \"ART6\",\n                    \"adt\": 2\n                },\n                {\n                    \"class\": 10,\n                    \"name\": \"BD\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 11,\n                    \"name\": \"DRT\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 12,\n                    \"name\": \"TRT\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 13,\n                    \"name\": \"???\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 14,\n                    \"name\": \"M/C\",\n                    \"adt\": 7\n                },\n                {\n                    \"class\": 15,\n                    \"name\": \"CYCLE\",\n                    \"adt\": 2\n                }\n            ],\n            \"adt\": 206.0,\n            \"awdt\": 218.0,\n            \"awedt\": 179.0,\n            \"the_85th\": 13.86,\n            \"the_85th_we\": 13.77,\n            \"the_85th_wd\": 13.86,\n            \"avg_speed\": 10.95,\n            \"avg_speed_we\": 10.62,\n            \"avg_speed_wd\": 11.05,\n            \"perc_light\": 96.82835820895522,\n            \"perc_medium\": 2.1144278606965172,\n            \"perc_heavy\": 0.1865671641791045,\n            \"perc_cycle\": 0.6218905472636815,\n            \"perc_motorcycle\": 0.12437810945273632,\n            \"perc_unclassifiable\": 0.12437810945273632,\n            \"class_ind_adt\": [\n                0,\n                206,\n                2,\n                4,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_ind_awedt\": [\n                0,\n                176,\n                2,\n                2,\n                2,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                1,\n                2,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_ind_awdt\": [\n                0,\n                216,\n                2,\n                4,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_scheme_name\": \"VRX\",\n            \"speed_limit\": null,\n            \"speed_diff\": null,\n            \"virtual_days\": {\n                \"WD\": {\n                    \"am_peak_hour_vol\": 20,\n                    \"pm_peak_hour_vol\": 18,\n                    \"am_peak_hour\": \"8:00-9:00\",\n                    \"pm_peak_hour\": \"16:00-17:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 1,\n                        \"2:00-3:00\": 1,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 1,\n                        \"5:00-6:00\": 2,\n                        \"6:00-7:00\": 5,\n                        \"7:00-8:00\": 14,\n                        \"8:00-9:00\": 20,\n                        \"9:00-10:00\": 14,\n                        \"10:00-11:00\": 10,\n                        \"11:00-12:00\": 14,\n                        \"12:00-13:00\": 14,\n                        \"13:00-14:00\": 11,\n                        \"14:00-15:00\": 15,\n                        \"15:00-16:00\": 17,\n                        \"16:00-17:00\": 18,\n                        \"17:00-18:00\": 18,\n                        \"18:00-19:00\": 17,\n                        \"19:00-20:00\": 8,\n                        \"20:00-21:00\": 7,\n                        \"21:00-22:00\": 4,\n                        \"22:00-23:00\": 4,\n                        \"23:00-24:00\": 1\n                    }\n                },\n                \"WE\": {\n                    \"am_peak_hour_vol\": 21,\n                    \"pm_peak_hour_vol\": 16,\n                    \"am_peak_hour\": \"11:00-12:00\",\n                    \"pm_peak_hour\": \"12:00-13:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 2,\n                        \"2:00-3:00\": 0,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 0,\n                        \"5:00-6:00\": 1,\n                        \"6:00-7:00\": 1,\n                        \"7:00-8:00\": 7,\n                        \"8:00-9:00\": 10,\n                        \"9:00-10:00\": 12,\n                        \"10:00-11:00\": 15,\n                        \"11:00-12:00\": 21,\n                        \"12:00-13:00\": 16,\n                        \"13:00-14:00\": 16,\n                        \"14:00-15:00\": 12,\n                        \"15:00-16:00\": 14,\n                        \"16:00-17:00\": 13,\n                        \"17:00-18:00\": 12,\n                        \"18:00-19:00\": 8,\n                        \"19:00-20:00\": 7,\n                        \"20:00-21:00\": 3,\n                        \"21:00-22:00\": 4,\n                        \"22:00-23:00\": 2,\n                        \"23:00-24:00\": 1\n                    }\n                },\n                \"WK\": {\n                    \"am_peak_hour_vol\": 17,\n                    \"pm_peak_hour_vol\": 17,\n                    \"am_peak_hour\": \"8:00-9:00\",\n                    \"pm_peak_hour\": \"16:00-17:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 1,\n                        \"2:00-3:00\": 1,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 1,\n                        \"5:00-6:00\": 2,\n                        \"6:00-7:00\": 4,\n                        \"7:00-8:00\": 11,\n                        \"8:00-9:00\": 17,\n                        \"9:00-10:00\": 13,\n                        \"10:00-11:00\": 12,\n                        \"11:00-12:00\": 16,\n                        \"12:00-13:00\": 14,\n                        \"13:00-14:00\": 12,\n                        \"14:00-15:00\": 14,\n                        \"15:00-16:00\": 16,\n                        \"16:00-17:00\": 17,\n                        \"17:00-18:00\": 17,\n                        \"18:00-19:00\": 15,\n                        \"19:00-20:00\": 7,\n                        \"20:00-21:00\": 6,\n                        \"21:00-22:00\": 4,\n                        \"22:00-23:00\": 3,\n                        \"23:00-24:00\": 1\n                    }\n                }\n            }\n        },\n        \"north_or_east_stats\": {\n            \"per_class_adt\": [\n                {\n                    \"class\": 0,\n                    \"name\": \"AR0\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 1,\n                    \"name\": \"SV \",\n                    \"adt\": 563\n                },\n                {\n                    \"class\": 2,\n                    \"name\": \"SVT\",\n                    \"adt\": 3\n                },\n                {\n                    \"class\": 3,\n                    \"name\": \"TB2\",\n                    \"adt\": 14\n                },\n                {\n                    \"class\": 4,\n                    \"name\": \"TB3\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 5,\n                    \"name\": \"T4 \",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 6,\n                    \"name\": \"ART3\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 7,\n                    \"name\": \"ART4\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 8,\n                    \"name\": \"ART5\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 9,\n                    \"name\": \"ART6\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 10,\n                    \"name\": \"BD\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 11,\n                    \"name\": \"DRT\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 12,\n                    \"name\": \"TRT\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 13,\n                    \"name\": \"???\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 14,\n                    \"name\": \"M/C\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 15,\n                    \"name\": \"CYCLE\",\n                    \"adt\": 1\n                }\n            ],\n            \"adt\": 97.0,\n            \"awdt\": 101.0,\n            \"awedt\": 86.0,\n            \"the_85th\": 13.81,\n            \"the_85th_we\": 13.85,\n            \"the_85th_wd\": 13.81,\n            \"avg_speed\": 10.83,\n            \"avg_speed_we\": 10.52,\n            \"avg_speed_wd\": 10.92,\n            \"perc_light\": 97.23320158102767,\n            \"perc_medium\": 2.2397891963109355,\n            \"perc_heavy\": 0.2635046113306983,\n            \"perc_cycle\": 0.13175230566534915,\n            \"perc_motorcycle\": 0.13175230566534915,\n            \"perc_unclassifiable\": 0.0,\n            \"class_ind_adt\": [\n                0,\n                101,\n                1,\n                2,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_ind_awedt\": [\n                0,\n                89,\n                1,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_ind_awdt\": [\n                0,\n                104,\n                1,\n                3,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_scheme_name\": \"VRX\",\n            \"speed_limit\": null,\n            \"speed_diff\": null,\n            \"virtual_days\": {\n                \"WD\": {\n                    \"am_peak_hour_vol\": 8,\n                    \"pm_peak_hour_vol\": 10,\n                    \"am_peak_hour\": \"8:00-9:00\",\n                    \"pm_peak_hour\": \"18:00-19:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 1,\n                        \"2:00-3:00\": 1,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 0,\n                        \"5:00-6:00\": 2,\n                        \"6:00-7:00\": 2,\n                        \"7:00-8:00\": 6,\n                        \"8:00-9:00\": 8,\n                        \"9:00-10:00\": 6,\n                        \"10:00-11:00\": 4,\n                        \"11:00-12:00\": 7,\n                        \"12:00-13:00\": 5,\n                        \"13:00-14:00\": 3,\n                        \"14:00-15:00\": 7,\n                        \"15:00-16:00\": 8,\n                        \"16:00-17:00\": 8,\n                        \"17:00-18:00\": 9,\n                        \"18:00-19:00\": 10,\n                        \"19:00-20:00\": 4,\n                        \"20:00-21:00\": 3,\n                        \"21:00-22:00\": 3,\n                        \"22:00-23:00\": 1,\n                        \"23:00-24:00\": 1\n                    }\n                },\n                \"WE\": {\n                    \"am_peak_hour_vol\": 8,\n                    \"pm_peak_hour_vol\": 8,\n                    \"am_peak_hour\": \"10:00-11:00\",\n                    \"pm_peak_hour\": \"13:00-14:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 2,\n                        \"2:00-3:00\": 0,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 0,\n                        \"5:00-6:00\": 0,\n                        \"6:00-7:00\": 0,\n                        \"7:00-8:00\": 4,\n                        \"8:00-9:00\": 6,\n                        \"9:00-10:00\": 5,\n                        \"10:00-11:00\": 8,\n                        \"11:00-12:00\": 7,\n                        \"12:00-13:00\": 7,\n                        \"13:00-14:00\": 8,\n                        \"14:00-15:00\": 7,\n                        \"15:00-16:00\": 7,\n                        \"16:00-17:00\": 4,\n                        \"17:00-18:00\": 5,\n                        \"18:00-19:00\": 3,\n                        \"19:00-20:00\": 3,\n                        \"20:00-21:00\": 2,\n                        \"21:00-22:00\": 3,\n                        \"22:00-23:00\": 2,\n                        \"23:00-24:00\": 1\n                    }\n                },\n                \"WK\": {\n                    \"am_peak_hour_vol\": 8,\n                    \"pm_peak_hour_vol\": 8,\n                    \"am_peak_hour\": \"8:00-9:00\",\n                    \"pm_peak_hour\": \"17:00-18:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 1,\n                        \"2:00-3:00\": 1,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 0,\n                        \"5:00-6:00\": 2,\n                        \"6:00-7:00\": 2,\n                        \"7:00-8:00\": 5,\n                        \"8:00-9:00\": 8,\n                        \"9:00-10:00\": 6,\n                        \"10:00-11:00\": 5,\n                        \"11:00-12:00\": 7,\n                        \"12:00-13:00\": 5,\n                        \"13:00-14:00\": 4,\n                        \"14:00-15:00\": 7,\n                        \"15:00-16:00\": 7,\n                        \"16:00-17:00\": 7,\n                        \"17:00-18:00\": 8,\n                        \"18:00-19:00\": 8,\n                        \"19:00-20:00\": 4,\n                        \"20:00-21:00\": 3,\n                        \"21:00-22:00\": 3,\n                        \"22:00-23:00\": 1,\n                        \"23:00-24:00\": 1\n                    }\n                }\n            }\n        },\n        \"south_or_west_stats\": {\n            \"per_class_adt\": [\n                {\n                    \"class\": 0,\n                    \"name\": \"AR0\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 1,\n                    \"name\": \"SV \",\n                    \"adt\": 632\n                },\n                {\n                    \"class\": 2,\n                    \"name\": \"SVT\",\n                    \"adt\": 7\n                },\n                {\n                    \"class\": 3,\n                    \"name\": \"TB2\",\n                    \"adt\": 9\n                },\n                {\n                    \"class\": 4,\n                    \"name\": \"TB3\",\n                    \"adt\": 3\n                },\n                {\n                    \"class\": 5,\n                    \"name\": \"T4 \",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 6,\n                    \"name\": \"ART3\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 7,\n                    \"name\": \"ART4\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 8,\n                    \"name\": \"ART5\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 9,\n                    \"name\": \"ART6\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 10,\n                    \"name\": \"BD\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 11,\n                    \"name\": \"DRT\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 12,\n                    \"name\": \"TRT\",\n                    \"adt\": 0\n                },\n                {\n                    \"class\": 13,\n                    \"name\": \"???\",\n                    \"adt\": 1\n                },\n                {\n                    \"class\": 14,\n                    \"name\": \"M/C\",\n                    \"adt\": 6\n                },\n                {\n                    \"class\": 15,\n                    \"name\": \"CYCLE\",\n                    \"adt\": 1\n                }\n            ],\n            \"adt\": 106.0,\n            \"awdt\": 114.0,\n            \"awedt\": 93.0,\n            \"the_85th\": 13.94,\n            \"the_85th_we\": 13.63,\n            \"the_85th_wd\": 14.0,\n            \"avg_speed\": 11.06,\n            \"avg_speed_we\": 10.72,\n            \"avg_speed_wd\": 11.16,\n            \"perc_light\": 96.46643109540636,\n            \"perc_medium\": 2.0023557126030624,\n            \"perc_heavy\": 0.11778563015312131,\n            \"perc_cycle\": 1.0600706713780919,\n            \"perc_motorcycle\": 0.11778563015312131,\n            \"perc_unclassifiable\": 0.23557126030624262,\n            \"class_ind_adt\": [\n                0,\n                110,\n                1,\n                1,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_ind_awedt\": [\n                0,\n                91,\n                2,\n                1,\n                2,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                1,\n                2,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_ind_awdt\": [\n                0,\n                116,\n                1,\n                2,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0,\n                1,\n                0,\n                0,\n                0,\n                0,\n                0,\n                0\n            ],\n            \"class_scheme_name\": \"VRX\",\n            \"speed_limit\": null,\n            \"speed_diff\": null,\n            \"virtual_days\": {\n                \"WD\": {\n                    \"am_peak_hour_vol\": 12,\n                    \"pm_peak_hour_vol\": 9,\n                    \"am_peak_hour\": \"8:00-9:00\",\n                    \"pm_peak_hour\": \"12:00-13:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 0,\n                        \"2:00-3:00\": 0,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 1,\n                        \"5:00-6:00\": 1,\n                        \"6:00-7:00\": 3,\n                        \"7:00-8:00\": 8,\n                        \"8:00-9:00\": 12,\n                        \"9:00-10:00\": 7,\n                        \"10:00-11:00\": 6,\n                        \"11:00-12:00\": 6,\n                        \"12:00-13:00\": 9,\n                        \"13:00-14:00\": 7,\n                        \"14:00-15:00\": 8,\n                        \"15:00-16:00\": 9,\n                        \"16:00-17:00\": 9,\n                        \"17:00-18:00\": 9,\n                        \"18:00-19:00\": 7,\n                        \"19:00-20:00\": 3,\n                        \"20:00-21:00\": 3,\n                        \"21:00-22:00\": 1,\n                        \"22:00-23:00\": 2,\n                        \"23:00-24:00\": 1\n                    }\n                },\n                \"WE\": {\n                    \"am_peak_hour_vol\": 14,\n                    \"pm_peak_hour_vol\": 8,\n                    \"am_peak_hour\": \"11:00-12:00\",\n                    \"pm_peak_hour\": \"12:00-13:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 0,\n                        \"2:00-3:00\": 0,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 0,\n                        \"5:00-6:00\": 1,\n                        \"6:00-7:00\": 1,\n                        \"7:00-8:00\": 3,\n                        \"8:00-9:00\": 4,\n                        \"9:00-10:00\": 6,\n                        \"10:00-11:00\": 7,\n                        \"11:00-12:00\": 14,\n                        \"12:00-13:00\": 8,\n                        \"13:00-14:00\": 7,\n                        \"14:00-15:00\": 5,\n                        \"15:00-16:00\": 7,\n                        \"16:00-17:00\": 8,\n                        \"17:00-18:00\": 7,\n                        \"18:00-19:00\": 5,\n                        \"19:00-20:00\": 4,\n                        \"20:00-21:00\": 2,\n                        \"21:00-22:00\": 1,\n                        \"22:00-23:00\": 1,\n                        \"23:00-24:00\": 0\n                    }\n                },\n                \"WK\": {\n                    \"am_peak_hour_vol\": 9,\n                    \"pm_peak_hour_vol\": 9,\n                    \"am_peak_hour\": \"8:00-9:00\",\n                    \"pm_peak_hour\": \"12:00-13:00\",\n                    \"hourly_vol\": {\n                        \"0:00-1:00\": 1,\n                        \"1:00-2:00\": 0,\n                        \"2:00-3:00\": 0,\n                        \"3:00-4:00\": 1,\n                        \"4:00-5:00\": 1,\n                        \"5:00-6:00\": 1,\n                        \"6:00-7:00\": 2,\n                        \"7:00-8:00\": 6,\n                        \"8:00-9:00\": 9,\n                        \"9:00-10:00\": 7,\n                        \"10:00-11:00\": 6,\n                        \"11:00-12:00\": 8,\n                        \"12:00-13:00\": 9,\n                        \"13:00-14:00\": 7,\n                        \"14:00-15:00\": 7,\n                        \"15:00-16:00\": 8,\n                        \"16:00-17:00\": 9,\n                        \"17:00-18:00\": 8,\n                        \"18:00-19:00\": 6,\n                        \"19:00-20:00\": 3,\n                        \"20:00-21:00\": 3,\n                        \"21:00-22:00\": 1,\n                        \"22:00-23:00\": 2,\n                        \"23:00-24:00\": 1\n                    }\n                }\n            }\n        }\n    }\n]\n\n

","urlObject":{"protocol":"https","path":["api","site_survey_statistics",""],"host":["atlyst","metrocount","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c52b7366-40df-4883-ae8c-dff2902a3249"},{"name":"site_yearly_statistics","id":"db213a87-3cca-43ae-bf81-b02f0791a04a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":""},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"APIKEY","value":"Contact MetroCount","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_ids\": [\n 19866\n ],\n \"start\": \"2010-01-01\",\n \"end\": \"2026-01-01\"\n}","options":{"raw":{"language":"json"}}},"url":"https://atlyst.metrocount.com/api/site_yearly_statistics/","description":"

This API is used to retrieve summary statistics for years

site_ids: list of site_ids you want to retrieve
start/end: you will want to retrieve the data from years lie in this period. format will be \"YYYY-mm-dd\"

Return data: a list of dict, each site has a dict.

site_id: site_id for this summary statistics data site_ids
name: name of this site
description: description
asset_management_id: asset_management_id if the site has
latitude/longitude: gps for the site
class_scheme: class_scheme name
heading: the directions for this site, will be \"South/North\", \"East/West\"
year: summary data for this year

Stats will be within the field below

combined_heading_stats: summary statistics calculated based on the vehicles from both directions
south_or_west_stats: summary statistics calculated based on south if the site is a south/north site, or west if the site is a west/east site
north_or_east_stats: summary statistics calculated based on north if the site is a south/north site, or east if the site is a west/east site

Within the stat:

per_class_adt: a list adt for each individual class in this class_scheme
- class: class_index, will be 0,1,2,3,xxx
- name: the name for this class_index
- adt: the adt for this class
\n
adt
awdt
awedt
the_85th: 85 pertcentile speed in m/s for all
the_85th_we: 85 pertcentile speed for vehicles in weekend, in m/s
the_85th_wd: 85 pertcentile speed for vehicles in weekday, in m/s
avg_speed
avg_speed_we
avg_speed_wd
virtual_days: virtual_day information in hour resolution, for weekday/whole week/weekend
- WE/WD/WK: weekend/weekday/whole_week
- am_peak_hour/pm_peak_hour: the peak hour for morning and afternoon, only 1 hour
- am_peak_hour_vol/pm_peak_hour_vol: peak hour volume for morning/afternoon
- hourly_vol: a dict with volume for each hour
  - key will be \"0:00-1:00\" to \"23:00-24:00\"
  \n
\n

\n","urlObject":{"protocol":"https","path":["api","site_yearly_statistics",""],"host":["atlyst","metrocount","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"db213a87-3cca-43ae-bf81-b02f0791a04a"},{"name":"individual_vehicles","id":"fe48c29d-c324-49f0-be17-0312d5bcf854","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"APIKEY","value":"Contact MetroCount","type":"text"}],"body":{"mode":"raw","raw":"{\n \"site_id\": 19866,\n \"start_timestamp\": \"2019-07-01T00:00:00+00:00\",\n \"limit\":10000\n}","options":{"raw":{"language":"json"}}},"url":"https://atlyst.metrocount.com/api/individual_vehicles/","description":"

This API is used to retrieve individual vehicle records for a specific site

site_id: target site id
start_timestamp: a timestamp in UTC timezone, e.g. \"2019-07-01T00:00:00+00:00\". The query will return vehicle greater than and NOT EQUAL to start_timestamp
limit: the max number of vehicles returned by the query. Default value 10,000 and should be from 100 to 100,000.

Return data:

\"datakey\": a list of description keys for the \"data\" object
\"data\": a list of vehicle records, where each record is described by the \"datakey\"

A sample datakey is:

\"timestamp(UTC)\", timestamp in UTC
\"localtime(Australia/Perth)\", timestamp in the site's timezone
\"heading\", direction of the vehicle, e.g. \"North\", \"South\"
\"velocity(m/s)\"
\"length(m)\"
\"headway(s)\"
\"class(Shared Path 02)\", classification of the vehicle
\"lane_index\", the lane index for the \"heading\" direction. For Realtime VM sites, \"lane_index\" combined with \"heading\" can be determined if vehicles are on the same lane, e.g. heading \"North\" with lane_index 1 means the lane \"North - 1\". For other sites, lane_index is not reliable and should not be used.

Example of the returning data

{\n    \"datakey\": [\n        \"timestamp(UTC)\",\n        \"localtime(Australia/Perth)\",\n        \"heading\",\n        \"velocity(m/s)\",\n        \"length(m)\",\n        \"headway(s)\",\n        \"class(Shared Path 02)\",\n        \"lane_index\"\n    ],\n    \"data\": [\n        [\n            \"2020-12-07T03:38:14.000+00:00\",\n            \"2020-12-07T11:38:14.000\",\n            \"South\",\n            12.0,\n            6.2,\n            13.0,\n            \"Ped\",\n            1\n        ],\n        [\n            \"2020-12-07T03:40:14.001+00:00\",\n            \"2020-12-07T11:40:14.001\",\n            \"South\",\n            15.21,\n            4.42,\n            2.00,\n            \"Ped\",\n            1\n        ],\n...\n]\n}\n\n

The vehicle records are sorted by \"timestamp(UTC)\" in ascending order. Client needs to decide whether to continue make queries according to the last \"timestamp(UTC)\". If client decides to make next query to retrive more consecutive vehicles, client has to use the last \"timestamp(UTC)\" as the \"start_timestamp\" in the new query.

Please check the Querying Individual Vehicles Code Example at the beginning of this documentation.

\n","urlObject":{"protocol":"https","path":["api","individual_vehicles",""],"host":["atlyst","metrocount","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe48c29d-c324-49f0-be17-0312d5bcf854"}]}