Get Tiles

post

https://api.mira.co/analytics/tiles/

Pull a tile layer from an adhoc request.

The only required parameter in this request is audience_id, but depending on what parameters are present, certain parameters become required. The API will return 400 Bad Requests with a description of what is missing.

Geo Parameters

If a market_id is specified, the tiles being returned will be restricted to that market. This can also be accomplished using the bounds parameter directly, but the query will run much faster with both market_id and bounds specified in the request.
If bounds is specified, then the request must also have zoom.
If level is specified, the would-be-computed level based on zoom is overridden. If you are requesting an entire market with no bounds, this will default to a certain "market-level", but can be overridden here.

Styling Parameters

If dynamic is set to True, but there are no bounds, it is ignored.
If dynamic is set to False, then market_id must be present.
If both buckets and colors are specified, the length of the colors array must be equal to the buckets parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

audience_id

integer

required

The audience ID for which to fetch tiles

market_id

integer

The market ID for which to restrict requested tiles. Is sometimes required depending on other parameters present.

bounds

array of numbers

Array with exatly 4 floats that represent the bounds of the viewport. These must be in west-south-east-north order, which is, respectively, a longitude, latitude, longitude, and latitude.

Bounds

zoom

integer

Web-mercator zoom level of the current viewport. This is combined with the bounds to determine the area of coverage and tile granularity needed in the response.

level

integer

S2 Cell Level to override level of tiles being returned

normalized

boolean

Defaults to true

Whether the scores in each tile should be averaged (True) or summed (False)

dynamic

boolean

Defaults to true

Whether the quantiles should be with respect to what is in the bounds, or with respect to ALL the tiles in the provided market (False).

buckets

integer

Defaults to 11

How many colors should be used to report scores

colors

array of strings

An array of hex codes to use, in order, as quantile colors

Colors

encode

boolean

Defaults to true

Testing only. Whether to encode the response as JSON

Response

200Successful Response