> ## Documentation Index > Fetch the complete documentation index at: https://unif.dev/llms.txt > Use this file to discover all available pages before exploring further. # Check field coverage > Reports which fields of an entity are populated for a given channel and market, and how fresh they are. Query this before you build a filter on a field, so you know whether it is available everywhere you plan to run. ## OpenAPI ````yaml /api-reference/openapi.yaml get /coverage openapi: 3.1.0 info: title: Unif API version: '2026-09-01' summary: One schema for commerce data across every channel. description: > The Unif API returns normalized commerce data — shops, products, creators, videos, livestreams and categories — through a single schema that does not change when the underlying data source does. Each request runs a cascade across the sources behind a channel, in cost order, stopping at the first result that verifies. You are charged for the hit, not for the attempts. See [the waterfall](/docs/concepts/waterfall). Every response is denominated in the currency you ask for, scoped to a market, and measured over a period you control, whichever source answered. **Base URL** ``` https://api.unif.dev/v1 ``` All requests require a bearer token. See [Authentication](/docs/authentication). **Conventions** - Success and failure are carried by the HTTP status code. There is no envelope to unwrap: a `200` body is the object itself, and any `4xx` or `5xx` body is an [error object](/docs/platform/errors). - Lists are cursor-paginated. Read `next_cursor` and stop when `has_more` is false. - Every response carries `X-Request-Id`. Billable responses also carry `X-Unif-Credits-Charged` and `X-Unif-Credits-Remaining`. - Monetary fields are converted to the `currency` you request, and every object repeats the `currency` and `period` it was measured under. contact: name: Unif Support email: support@unif.dev url: https://unif.dev/docs license: name: Proprietary url: https://unif.dev/legal/terms servers: - url: https://api.unif.dev/v1 description: Production security: - bearerAuth: [] tags: - name: Meta description: Workspace, channel availability and field coverage. - name: Shops description: Storefronts and sellers. - name: Products description: Listings, pricing and sales performance. - name: Creators description: Affiliates and influencers who sell. - name: Videos description: Short-form video attributed to sales. - name: Livestreams description: Live selling sessions. - name: Categories description: The normalized category tree and category-level market data. - name: Resolution description: Turn a URL, handle or external ID into a Unif entity. - name: Jobs description: Asynchronous work for large searches, enrichments and exports. - name: Lists description: Saved sets of entities. - name: Trackers description: Scheduled re-checks that emit webhook events on change. - name: Webhooks description: Endpoint registration and delivery settings. - name: Usage description: Credit balance and per-request consumption. paths: /coverage: get: tags: - Meta summary: Check field coverage description: > Reports which fields of an entity are populated for a given channel and market, and how fresh they are. Query this before you build a filter on a field, so you know whether it is available everywhere you plan to run. operationId: getCoverage parameters: - $ref: '#/components/parameters/EntityTypeQuery' - $ref: '#/components/parameters/ChannelQuery' - $ref: '#/components/parameters/MarketQuery' responses: '200': description: Field coverage for the requested entity. content: application/json: schema: $ref: '#/components/schemas/CoverageReport' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' components: parameters: EntityTypeQuery: name: entity in: query required: true description: The entity type to report coverage for. schema: $ref: '#/components/schemas/EntityType' ChannelQuery: name: channel in: query description: > Restrict to one channel. Omit to span every channel your workspace has enabled — each returned object names its own `channel`. schema: $ref: '#/components/schemas/Channel' MarketQuery: name: market in: query description: The market to measure, as an ISO 3166-1 alpha-2 code. schema: $ref: '#/components/schemas/Market' schemas: CoverageReport: type: object properties: object: type: string const: coverage entity: $ref: '#/components/schemas/EntityType' fields: type: array items: type: object properties: field: type: string examples: - metrics.revenue channel: $ref: '#/components/schemas/Channel' market: $ref: '#/components/schemas/Market' availability: type: string enum: - full - partial - unavailable filterable: type: boolean sortable: type: boolean typical_lag_hours: type: - integer - 'null' description: >- Usual delay between an event on the channel and it appearing here. note: type: - string - 'null' EntityType: type: string enum: - shop - product - creator - video - livestream - category Channel: type: string description: > A sales channel — the commerce surface a request is about. Behind each channel is a cascade of data sources, tried in cost order until one verifies; the roster is published, but which source answered a given row is not carried in the response, so the cascade can be re-tuned without breaking your code. enum: - tiktok_shop examples: - tiktok_shop Market: type: string description: An ISO 3166-1 alpha-2 country code identifying a channel storefront. enum: - US - GB - IE - ES - FR - DE - IT - ID - TH - VN - MY - PH - SG - JP - BR - MX examples: - US ErrorResponse: type: object required: - error properties: error: $ref: '#/components/schemas/Error' Error: type: object properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - not_found_error - rate_limit_error - billing_error - coverage_error - api_error code: type: string examples: - parameter_invalid message: type: string param: type: - string - 'null' description: The offending field as a dot-path.: null doc_url: type: string format: uri request_id: type: string responses: BadRequest: description: The request was malformed or a parameter was invalid. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: invalid_request_error code: parameter_invalid message: filters.revenue.gte must be a non-negative number. param: filters.revenue.gte doc_url: https://unif.dev/docs/platform/errors#parameter_invalid request_id: req_01k3m9x7v2q8r4t6y0b1n5d7fa Unauthorized: description: The API key is missing, malformed or revoked. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: type: authentication_error code: invalid_api_key message: No API key was provided in the Authorization header. doc_url: https://unif.dev/docs/platform/errors#invalid_api_key request_id: req_01k3m9x7v2q8r4t6y0b1n5d7fa headers: RequestId: description: Unique ID for this request. Include it in support conversations. schema: type: string securitySchemes: bearerAuth: type: http scheme: bearer description: > Send your workspace API key as a bearer token: ``` Authorization: Bearer unif_sk_live_... ``` Keys are scoped to a single workspace. See [Authentication](/docs/authentication). ````