PEpeec
Agent Analytics

Request Agent Readiness Audits

Changed on

Queue Peec's agent readiness audit for the project's own brand domains. Audits run only on domains of the project's own brands, matched exactly as the brand lists them; any other domain is returned in rejected and the rest of the request still goes through. A domain whose audit is already queued or running is returned in skipped with that run's id instead of queuing a second one.

Audits run in the background. Follow each one with GET /agent-analytics/readiness, where the domain's latest_run carries the same id and its status, and read the result there once it is completed.

post/agent-analytics/readiness/audits

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/agent-analytics/readiness/audits
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Request body

project_idstring

Required if using a company api key

domainsstring[] required

Up to 50 of the project's own brand domains, exactly as GET /agent-analytics/readiness lists them in own.

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "domains": [
    "peec.ai"
  ]
}

Response

Per-domain results

Example response

{
  "created": [
    {
      "domain": "peec.ai",
      "run_id": "0199c3a4-5b6e-7f80-9a1b-2c3d4e5f6a7b"
    }
  ],
  "skipped": [
    {
      "domain": "peec.ai",
      "run_id": "0199c3a4-5b6e-7f80-9a1b-2c3d4e5f6a7b"
    }
  ],
  "rejected": [
    {
      "domain": "acme.com"
    }
  ]
}

Changes