Skip to main content

Tag and Track Usage

You can segregate and track usage statistics on your API Key by using our tagging feature. This allows you tag tag individual API requests and have the tag returned in your usage logs for later sorting and analysis.

Tag a Request

For each property you can append a tag to your request using tags=. For instance, for webpage.co.uk you could append tags=a.

If you’re using the HTTP API directly the request will go from:

https://api.ideal-postcodes.co.uk/v1/postcodes/sw1a2aa?api_key=iddqd

To this:

https://api.ideal-postcodes.co.uk/v1/postcodes/sw1a2aa?api_key=iddqd&tags=a

The tag will appear in your CSV usage log in the last column:

usage excel  

If you are using the JavaScript API Client or our Address Finder / Postcode Lookup library, they will provide an interface to inject a tag. For instance, with Address Finder, there’s a tags attribute.

Track by Tag

There are 2 ways to generate usage statistics.

  1. Our daily usage statistics API
  2. Our key usage CSV export API

Both are available on the dashboard. Click Filter by Tags and enter the tag (in this case a) to get back the usage

usage dashboard

If you wish to do quite heavy analysis, we recommend outputting all your CSV usage without tag filtering. Then load the CSV into excel and use Excel’s Filter functionality to filter the tag column and do the analysis there.

Please contact us if you have any questions.