Skip to main content

Create AI visibility audits for Query Fan-Out

POST 
/ai-visibility-audits

Create AI visibility audits for Query Fan-Out

Request​

Header Parameters

    authorization object

Body

required

    urlurirequired

    The URL to analyze

    Possible values: non-empty and <= 2083 characters

    num_queriesNum Queries (integer)

    Number of synthetic queries to generate

    Possible values: >= 1 and <= 20

    Default value: 10
    coverage_thresholdCoverage Threshold (number)

    The threshold for answering synthetic queries

    Possible values: <= 1

    Default value: 0.65

Responses​

Successful Response

Schema

    urlUrl (string)required
    num_queries_requestedNum Queries Requested (integer)required
    coverage_thresholdCoverage Threshold (number)required
    entity_nameEntity Name (string)required
    query_reasoningQuery Reasoning (string)required
    covered_countCovered Count (integer)required
    total_queriesTotal Queries (integer)required

    query_details

    object[]

    required

  • Array [

    • queryQuery (string)required
    is_coveredIs Covered (boolean)required
    similaritySimilarity (number)required

  • ]

    • content_chunks_countContent Chunks Count (integer)required
    coverage_scoreCoverage Score (number)required