Research coverage for this directory
How many listings have been read, how many are outstanding, how many are still fresh, and how many can never be read because they carry no website. outstanding is measured against eligible rather than the whole directory, so it does not read as a pipeline still catching up when there is nothing left to do.
fields.missing lists the attribute templates this directory has not declared. Anything named there is a field research will gather and then have nowhere to put — call POST .../research with declareFields: true to create them.
Requires the write scope, unlike other reads: it counts non-published listings, so it is gated with the sweep it reports on rather than with published reads.
Request
- Base URL: https://api.epicdirectories.com
- URL: https://api.epicdirectories.com/public/v1/directories/{directory}/research
- Auth: API key in header x-api-key
Path parameters
Query parameters
Headers
Optional. Send a unique key per logical operation to make retries safe. 1-256 characters, and only letters, digits, - and _ — colons and other separators are rejected with 400. A retry with the same key replays the original response (status + body) instead of re-executing. Cached for 24h. Reusing a key with a different request body returns 409 — note that a timestamp in the body (e.g. fetchedAt) turns an otherwise-stable key into a permanent 409, so either omit it (snapshots default it server-side) or fold a payload digest into the key. Skipped on 5xx responses (transient errors should be retried fresh).
API Key for authentication
Response
Coverage counts plus which fields are declared
Changes
No recorded changes to this operation across all 1 revision of this API.