REST API

Meridian has developed a new REST API that uses a consistent underlying structure. The original API is still available.

Only documented APIs are supported. Undocumented APIs are unsupported and subject to change.

The API Structure

The new API structure is consistent, regardless of the resource you're accessing and the method you're using.

https://edit.meridianapps.com/api/{resource1}/{unique id1}/{resource2}/{unique id2}

API Example

For example, if you wanted to get data on a specific campaign for a location, you'd use:

https://edit.meridianapps.com/api/locations/{location_id}/placemarks/{placemark_id}

or

https://edit.meridianapps.com/api/locations/12345678901234/placemarks/987654321987

Get a List of Items

Requesting data from an endpoint without a specific ID will return a paged list of items. By default, the list is limited to 100 items.

https://edit.meridianapps.com/api/locations/{location_id}/placemarks

Get the Next Page of Items

If the list of items is greater than the page limit, the API will provide a URL to the next list page:

https://edit.meridianapps.com/api/locations/12345678901234/placemarks?page={next page ID}

The page_size Property

Using the page_size property, you can change the number of items returned by the Meridian API at one time.

By default, the page_size is 100 items.

To change the page_size in your API request, use:

`?page_size=250`

The previous example would return a maximum of 250 items on single page.

You can set page_size to a maximum value of 10000.

You will undoubtedly experience adverse effects on your performance if you use the maximum page_size.

If you set page_size to 10000, the API will still only return up to 5000 items on a single page.