Other/API Reference - Ideal Postcodes

Logs (CSV)

v1.0.0

Reports lookup information on a key for paid lookups.

This method requires a user_token, which can be found on your .

A maximum interval of 90 days can be provided for analysis. If no start or end date is provided, the last 21 days will be used as the default interval.

Download Usage History (CSV)

GET /keys/:key/lookups

Returns a CSV download of lookups performed and associated information.

Note that the Content-Type returned will be CSV (text/csv). For a non 200 response, the Content-Type will revert to JSON with the error code and message embedded.

Data Redaction

Personally Identifiable Data (PII) caught in this your usage log (including IP, search term and URL data) will be redacted on a weekly basis.

By default, PII will be redacted if it is older than 21 days. This timeframe can be configured from your dashboard.

You may prevent PII collection altogether by setting the interval to 0 days.

Input

{
  "type": "object",
  "properties": {
    "end": {
      "type": "integer",
      "format": "int32",
      "description": "An start date/time in the form of a UNIX Timestamp in milliseconds, e.g.  `1418556477882`.\n"
    },
    "key": {
      "type": "string",
      "description": "Your API Key. Typically beings `ak_`.\n\nAvailable from your dashboard\n"
    },
    "licensee": {
      "type": "string",
      "description": "Uniquely identifies a licensee\n"
    },
    "start": {
      "type": "integer",
      "format": "int32",
      "description": "A start date/time in the form of a UNIX Timestamp in milliseconds, e.g.  `1418556452651`.\n"
    }
  },
  "required": [
    "key"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}