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 Bearer token. Example: Bearer qw-api-xxx
GET /api/v1/brands/{brandId}/local
Path Parameters The unique identifier of the brand
Query Parameters Number of days to include. If not specified, returns all data.
Start date (ISO 8601 format)
End date (ISO 8601 format)
Filter by business category (case-insensitive partial match)
Maximum number of businesses to return (max: 100)
Number of results to skip for pagination
sort
string
default: "createdAt"
Field to sort by: createdAt, rating, reviewCount, position, businessName
Response Indicates if the request was successful
Total number of businesses matching filters
Number of businesses in this response
Show Local business object
Position in the list (1 = top result)
Original prompt that triggered this result
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 Status Code Description 401 INVALID_TOKENAuthentication failed 404 BRAND_NOT_FOUNDBrand doesn’t exist or not accessible
