Logs (CSV)
Returns a CSV of the charged lookups made on a key, one row per request.
Requires the account Management Key. The maximum interval is 90 days. Without a start or end date the interval is the last 21 days.
The response is text/csv and downloads as an attachment. A non-200 response reverts to JSON, with the error code and message in the body.
CSV format
The CSV has no header row. Columns, in order:
- Timestamp (ISO 8601)
- IP address the request was received from
- Search term
- URL the request originated from
- Lookup type
- Tags
- Lookups consumed
- Licensee name (sublicensing keys only)
- Source IP address
The source IP column carries the address forwarded in the AZ-Source-IP header. We record it only for keys with IP address forwarding enabled, and only when the header holds a valid IP address. It is empty otherwise.
Data redaction
We redact personally identifiable data (PII) in your usage log weekly, covering the IP, source IP, search term and URL columns.
The default retention is 28 days. Change the period from your dashboard. Set it to 0 days to stop collecting PII altogether.
Request
- Base URL: https://api.addresszen.com/v1
- URL: https://api.addresszen.com/v1/keys/{key}/lookups
- Auth: HTTP bearer
Path parameters
API Key
The API Key to retrieve. Begins ak_.
Query parameters
Management Key
A secret key used to manage your account and API Keys. It was previously called the user token.
Your management key can be retrieved and managed from your accounts page.
Typically begins uk_.... Prefer the Authorization: Bearer uk_... header.
Start Timestamp
A start date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556452651
End Timestamp
An end date/time in the form of a UNIX Timestamp in milliseconds. E.g. 1418556477882
Licensee Key
Uniquely identifies a licensee.
Response
Success
Changes
No recorded changes to this operation across all 1 revision of this API.