Search analyses

get

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

StreetLight InSight® Planning API

Query Params

created_date_from

string

Returns analyses created on or after 00:00 UTC (EST + 5 hours) on this date. Use the format MM/DD/YYYY.

created_date_to

string

Returns analyses created on or before 23:59 UTC (EST + 5 hours) on this date. Use the format MM/DD/YYYY.

name_contains

string

Returns analyses where the titles include this string. Separate different words with a space; the order of words is not considered. Case insensitive.

analysis_type

string

enum

Returns analyses with the specified type.

travel_mode_type

string

enum

Returns analyses with the specified travel mode.

tags

string

Returns analyses with the specified tags. The terms are not case-sensitive and will return results if any part of the string is in the name of the analysis tag. For example, searching "all volume" would return an analysis called "All Vehicles Volume".

in_queue

string

enum

Return analyses that are waiting to run or running. These count towards the processing limit associated with your API key.

Allowed:

key_name

string

Return analyses that were created with the named API key. Note this will not work with historically created analyses.

Responses

Language

Credentials

Query

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400