Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qwairy.co/llms.txt

Use this file to discover all available pages before exploring further.

Access local business recommendations extracted from AI responses, primarily from Google AI Overview local results. Track which businesses AI platforms recommend for location-based queries.

​
List Local Insights

​
Authorization
string
required
Bearer token. Example: Bearer qw-api-xxx
GET /api/v1/brands/{brandId}/local

​
Path Parameters

​
brandId
string
required
The unique identifier of the brand

​
Query Parameters

​
period
number
Number of days to include. If not specified, returns all data.
​
startDate
string
Start date (ISO 8601 format)
​
endDate
string
End date (ISO 8601 format)
​
provider
string
Filter by AI provider. Supports comma-separated multi-select (e.g., chatgpt,claude).
​
category
string
Filter by business category (case-insensitive partial match)
​
limit
number
default:"50"
Maximum number of businesses to return (max: 100)
​
offset
number
default:"0"
Number of results to skip for pagination
​
sort
string
default:"createdAt"
Field to sort by: createdAt, rating, reviewCount, position, businessName
​
order
string
default:"desc"
Sort order: asc or desc

​
Response

​
success
boolean
Indicates if the request was successful
​
pagination
object
​
local
array

​
Example Request

curl -X GET "https://www.qwairy.co/api/v1/brands/cm1234567890abcdef/local?category=restaurant&limit=10" \
  -H "Authorization: Bearer qw-api-your-token-here"

​
Example Response

{
  "success": true,
  "pagination": {
    "total": 42,
    "count": 2,
    "limit": 10,
    "offset": 0
  },
  "local": [
    {
      "id": "loc1",
      "businessName": "La Maison Restaurant",
      "category": "French Restaurant",
      "address": "123 Main Street, Paris",
      "websiteUrl": "https://lamaison.fr",
      "position": 1,
      "rating": 4.8,
      "reviewCount": 2500,
      "prompt": "Best French restaurants in Paris",
      "createdAt": "2024-12-15T10:30:00Z"
    },
    {
      "id": "loc2",
      "businessName": "Café Central",
      "category": "Café",
      "address": "45 Avenue Montaigne, Paris",
      "websiteUrl": "https://cafecentral.fr",
      "position": 2,
      "rating": 4.5,
      "reviewCount": 1800,
      "prompt": "Best French restaurants in Paris",
      "createdAt": "2024-12-15T10:30:00Z"
    }
  ]
}

​
Error Responses

StatusCodeDescription
401INVALID_TOKENAuthentication failed
404BRAND_NOT_FOUNDBrand doesn’t exist or not accessible