Metadata or Tagging

Any request which affects your Key balance may be decorated with metadata. This data is stored along with your lookup history and can be queried via the API. We call the ability to label your requests tagging.

Tagging can be useful for recording the circumstances under which a request was made. For instance, you may use it to identify which of your servers, users or staff are performing request with your key.

Tagged requests can be queried or downloaded at a later date via our API or the dashboard.

Tagging Example

Tagging is available across all methods which affect your lookup balance. To use it, include a comma separated list of tags in the query string of your URI

https://api.ideal-postcodes.co.uk/v1/postcodes/SW1A2aa?api_key=iddqd&tags=RSanchez,C137,Earth

Notes

Tagging is only available methods that drain your balance such as postcode or address search. Unsuccessful requests (i.e. non-2000 responses) do not affect your balance and so cannot be tagged.

You may query tagged requests via the /keys endpoint. The key usage API allows you to query for usage by tag. The CSV lookup history API will also provide tag data with every request.

Tag storage and searching is also case sensitive.

Restrictions

There are a small number of restrictions on what may be tagged.

  • You may only specifiy up to 5 individual tags
  • Each tag must not be longer than 16 UTF-8 characters

If you would like any of these restrictions lifted, please get in contact with us.