Get Demand Surges
Identify dates with surges in demand caused by multiple events happening at the same time and location.
The Demand Surge API can be used to quickly scan a period of 90 days for abnormal increases in attendance for a given area. The API calculates the mean attendance for your requested location across 90 days, then returns all the dates where attendance is a certain number of standard deviations over the mean. This is represented by the min_surge_intensity
parameter, which corresponds to the number of standard deviations the API will look for.
Once identified, demand surges can be further explored in our Events or Features APIs, to find the names, descriptions and details of the events that constitute the surges.
Request
HTTP Request
Query Parameters
Parameter | Description |
---|---|
| The start date of the demand surge search window.
The accepted format for this parameter is |
| The end date of the demand surge search window.
The accepted format for this parameter is |
| Filters out demand surges smaller than the minimum surge intensity provided. Possible values:
E.g. |
| Filters out demand surges not included in the location specified. Supports
|
Response
Response Fields
Field | Description |
---|---|
| The number of identified demand surges given the search criteria. |
| An array of identified demand surges. |
| The date of the identified demand surge. |
| The sum of all attendance based features in the identified demand surge. |
Examples
Last updated