API Reference

Create and run an analysis

post
https://insight.streetlightdata.com/api/v2/analyses

StreetLight InSight® Planning API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The email you use to log in to StreetLight InSight

string

A name for the analysis that is case-insensitive unique within your organization and no longer than 50 characters. If you do not specify this property, the server assigns the UUID as the name.

string

Additional descriptive information about the analysis.

string
enum
required

The type of analysis to run. Only certain combinations of analysis_type and travel_mode_type are supported. For more information, see Supported analysis type and travel mode combinations.

string
enum
required

The travel mode to analyze. Only certain combinations of analysis_type and travel_mode_type are supported. For more information, see Supported analysis type and travel mode combinations.

string
enum

Defines the truck weight classes that analysis metrics describe. Only available when travel_mode_type is Truck.

Allowed:
string
enum
Defaults to volume

The output type that defines the type of metrics the analysis returns.

Allowed:
date_ranges
array of objects

A list of date ranges where each date range is an object containing a pair of MM/DD/YYYY dates that define the start and end of the dates to analyze (inclusive). For Truck Origin-Destination analyses that use historic truck data, October through December 2022 are not supported as analysis months; choose other available periods.

date_ranges
string
Defaults to All Day|0023,Early AM|0005,Peak AM|0609,Mid-Day|1014,Peak PM|1518,Late PM|1923

A comma-separated list of day parts in the analysis. Each day part is a name, vertical bar, then the start hour and end hour from 00 (midnight) to 23 (11 PM). 'All Day|0023' ranges from midnight (00:00) to 11:59 PM. Analyses must define All Day as 0023 (midnight to midnight) and this day part is added if it is not present.

string
Defaults to Weekday|14,Weekend Day|67,All Days|17

A comma-separated list of day types in the analysis. Each day type is a name, the vertical bar, then the start day of week to the end day of week (1 for Monday through 7 for Sunday). Analyses must define All Day as "17" (Monday through Sunday) and this day type is added if it is not present.

oz_sets
array of objects
required

Array of zone sets that include the zones that will be analyzed. For analyses where you define origin and destination zones, oz_sets specifies the origin zone sets in the analysis. For these analysis types, also set dz_sets.

oz_sets*
dz_sets
array of objects

Array of zone set objects that contain destination zone sets for analysis types that require you to define origin and destination zones.

dz_sets
mfz_sets
array of objects

Array of zone set objects that contain Middle Filter zones for the Origin-Destination through Middle Filters analysis type. All zones in these zone sets must be pass through.

mfz_sets
string
enum

Specifies whether distances in analysis results are in miles or kilometers. By default, the unit is set based on your organization's location.

Allowed:
string
enum

The type of standard geography where trips are analyzed. Required for Trips to or from Pre-set Geography analyses.

Allowed:
integer
2000 to 2099

Year of analysis; only required for an AADT Analysis

string
enum

The categories of road segments to be analyzed. Only required for Top Routes between Origins and Destinations Analysis or Top Routes for Zones Analysis.

Allowed:
boolean

Specifies that the analysis returns traveler demographics and trip purpose metrics.

boolean

Specifies that the analysis returns trip attribute metrics as a percentage of trips in each bin, or range, for each attribute. For default trip attribute ranges, see Trip attributes.

string

If trip_attributes is enabled, you can edit the default ranges with a a comma-separated list of speed ranges.

string

If trip_attributes is enabled, you can edit the default ranges with a comma-separated list of trip duration, or travel time, ranges in minutes.

string

If trip_attributes is enabled, you can edit the default ranges with a a comma-separated list of trip length ranges in the specified unit of measurement.

string

If trip_attributes is enabled, you can edit the default ranges with a a comma-separated list of trip circuity ranges. Trip circuity is the average ratio of trip length to the direct distance between the start and endpoints of the trip.

boolean

Returns speed values for 5th, 15th, 85th, and 95th percentiles, or for specified percentile bins.

string

If enable_speed_percentile is true, you can specify a comma-separated list of integers defining speed percentiles (must be multiples of 5). Percentile values must be between 0 and 100. Default percentile values are "5,15,85,95".

string

Only for Origin-Destination analyses. If trip_attributes is true, you can specify a comma-separated list of integers defining trip length percentiles (must be multiples of 5). Percentile values must be between 0 and 100.

string

Only for Origin-Destination analyses with Truck and data from Jan 2023 and later. If trip_attributes is true, you can specify a comma-separated list of integers defining trip travel time percentiles (must be multiples of 5). Percentile values must be between 0 and 100.

cz_sets
array of objects

Array of zone sets with calibration zones. Required when creating an analysis with Zone Counts output.

cz_sets
boolean

Specifies whether the analysis includes Home and Work Locations metrics.

boolean

Returns metrics for visitors to the zone. These are the trips of devices that do not have a home or work location within the zone. It applies only to Zone Activity analyses with enable_home_work_locations set to true.

boolean

Returns metrics for residents of the zone. These are the trips of devices that have a home location within the zone. It applies only to Zone Activity analyses with enable_home_work_locations set to true.

boolean

Returns metrics for workers of the zone. These are the trips of devices that have a work location within the zone. It applies only to Zone Activity analyses with enable_home_work_locations set to true.

string
enum

Applies only to Zone Activity Analysis with Home and Work Locations metrics enabled.

Allowed:
string
enum
Defaults to segment

If you are running a Network Performance analysis, select the type of metrics. Spot metrics describe vehicles at the midpoint of a road segment; segment metrics describe vehicles over the length of a road segment.

Allowed:
tags
array of strings

Array of tag name strings to apply to the identified analyses. Tags must already be created to add them to an analysis.

tags
boolean

Specifies whether the analysis returns metrics in 15-minute day parts.

boolean

Specifies whether the analysis will process with upsampling if it meets the necessary thresholds. This setting only applies to analyses with enable_15min enabled.

boolean

Specifies whether the analysis will generate a visualization you can view in the StreetLight InSight Web Application.

boolean

Specifies whether the analysis will send an email upon its completion.

Responses

Updated 8 months ago

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago