aria-partner-api

Site API

A site is a Kanary Site row keyed by domain (brokers, forums, social platforms, etc.).

List available sites

GET /api/v1/sites/

Returns a paginated page of catalog entries (validated sites only). See Pagination.

Query parameters

Param Default Max Description
limit 100 250 Sites per page (Pagination)
offset 0 — Starting index into the catalog
product_id — — When set, return only sites whose eligible_product_ids includes this id. Omit to return the full catalog

Example

GET /api/v1/sites/?limit=100&offset=0

Response (200 OK)

The envelope includes a top-level last_updated_at field (when any site in the catalog was last changed) alongside the standard pagination fields.

{
  "count": 1,
  "next": null,
  "previous": null,
  "last_updated_at": "2026-05-18T12:00:00Z",
  "results": [
    {
      "site_id": 1,
      "domain": "example.com",
      "eligible_product_ids": [101, 103, 301],
      "created_at": "2026-05-18T12:00:00Z",
      "updated_at": "2026-05-18T12:00:00Z"
    }
  ]
}
Field Description
count Total sites in the catalog
next URL for the next page, or null
previous URL for the previous page, or null
last_updated_at When any site in the catalog was last changed — useful for cache invalidation
results Current page of catalog entries

Each item in results:

Field Description
site_id Kanary site primary key
domain Site domain, e.g. spokeo.com
eligible_product_ids Catalog product_ids whose scan includes this site
created_at When the site was added to the catalog (ISO 8601, UTC)
updated_at When the site record was last changed (ISO 8601, UTC)

Errors

Status Condition
400 Invalid limit or offset
401 Missing or invalid bearer token
403 Partner inactive

Retrieve a site

GET /api/v1/sites/{site_id}/

Returns one site by Kanary site_id (from the catalog or from site_id on Exposure API payloads). Sites are only available if they are validated kanary-wide or present in your organization’s exposure list.

Errors

Status Condition
401 Missing or invalid bearer token
403 Partner inactive
404 Site not found (unknown id or not visible to this partner)