Get Statistical Data for Map

post

https://api-dev.socialsensing.com/v1/map/{map}/stats

Returns an object mapping regions to their statistics. At present the two statistics are exceedance and total count. If there are no results for the criteria for a given region it will not included in the results. The result will look like this:

{
  "west yorkshire": {
    "count": 109,
    "exceedance": 0.4697
  },
   "shropshire": {
     "count": 71,
     "exceedance": 0.4697
   },

...
}

To get a list of all maps, their ids and available region types, use Get Metadata for All Maps. The list of available regions types and hazards can be obtained using Get Metadata for Map by Id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

map

string

required

The map id to use for the request, the set of ids can be obtained using Get Metadata for All Maps

Body Params

hazards

array of strings

required

Hazards represent the weather condition that you are interested in. The list of supported hazards can be found using Get Metadata for Map by Id.

hazards*

sources

array of strings

required

The source is name of the service that the data was gathered from. At present only the 'twitter' source is supported.

sources*

warnings

string

required

The warnings option is used to decide whether to include warnings (automated Tweets publishing weather warnings) should be included in the results.

'include' includes warnings.
'exclude' does not include warnings.
'only' only returns warnings.

regionType

string

required

The type of the regions specified by the regions property. The list of available regions types can be obtained using Get Metadata for Map by Id.

startDate

integer

required

The minimum JavaScript time in milliseconds to return a result for.

endDate

integer

The maximum JavaScript time in milliseconds to return a result for.

Responses

200OK

400Invalid Parameter