Local Ranking Grids

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

What's not available yet

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.

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 always returns the most recent screenshot for the grid, so you can use it as a static link in your reporting tools or embed it with an <img> tag — it will automatically update when a new scan completes.