Local Ranking Grids API

Beta — The Local Ranking Grids API is currently in beta. Endpoints and response formats may change as we iterate.

Overview

The API provides access to your list of grids and summary metrics, making it straightforward to integrate with third-party reporting tools.

What's available

List grids — Retrieve a paginated list of your ranking grids with summary metrics including visibility score, average rank, and review score.
Latest screenshot URL — Each grid has a public URL that always resolves to the most recent screenshot, allowing you to embed up-to-date grid visuals directly into reports and dashboards.

What's not available yet

Querying individual data points within a grid
Competitor data points
Creating new grids
Modifying existing grids/run schedules.

Authentication

All API requests require a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Generating an API key

You can generate an API token directly in the app. Click your profile dropdown in the top right and select API Access.

API Access screenshot

Interactive API Reference

Explore the full API schema and try requests interactively in the API Reference.

Pagination

GET /grids returns results in pages. Control pagination with query parameters:

Parameter	Description
`page`	The page number to retrieve. Defaults to `1`.
`per_page`	Number of grids to return per page. Defaults to `50`, maximum `100`. Values above the maximum are clamped to it.

Each response includes a meta object alongside data:

{
    "data": [ /* ... */ ],
    "meta": {
        "current_page": 1,
        "last_page": 3,
        "per_page": 50,
        "total": 132
    }
}

Latest Screenshot URL

You can embed the latest screenshot for any grid using the following URL pattern:

GET /grid/{grid_id}/download-screenshot/{mode}

Parameter	Description
`grid_id`	The UUID of the grid. Find this in the URL when viewing your grid.
`mode`	Should the screenshot include metrics in the image. Options: `with-metrics`, `without-metrics`

This URL returns the most recent available screenshot for the grid, so you can use it as a static link in your reporting tools or embed it with an <img> tag. If no screenshot exists for the grid yet, it returns a 404.

Screenshots are generated when you request one from the grid page. To keep this URL up to date automatically, enable Automatic screenshots on the API access page — every completed scan will then generate a screenshot without any manual action.