Generate a visibility report

Starts building the local visibility report for a target and returns right away. Needed parameters: target_id path parameter. Optional body with the radius to measure at (5km, 10km, 15km, 20km, 5mi, 10mi, 15mi, 20mi); without a body it is 5km, as before. Purpose: produce the one page report you send to the business owner - Maps ranking on a grid of points, competitors, review score and position on the AI assistants. It takes about half a minute: the response comes back with status pending and no addresses yet. Poll the report endpoint until the status is ready, then read report_url and pdf_url. The report is charged to your balance, and the language is the one set in your pipeline settings. The radius you choose is the distance between the points of the Maps grid and the radius in the question put to the AI assistants, and it comes back on the report.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Target id path parameter (required).

Body Params

Quello che si decide quando si chiede un report. Il corpo si puo' anche non mandare.

string
enum
Defaults to 5km

How far out to measure: 5km, 10km, 15km, 20km, or the same in miles (5mi, 10mi, 15mi, 20mi). It is the distance between the points of the Google Maps grid and the radius in the question put to the AI assistants. Pick it per business: a city restaurant competes with whoever is two streets away, a roofing contractor with whoever is twenty kilometres away. Defaults to 5km.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json