Get started

Quickstart

Create a read key, select a project, and fetch your first report.

On this page

Create a key

#

As the workspace owner, open Settings → API Keys. Enable API access if this is your workspace's first key. Give the key a name, select read, and choose an expiry.

Copy the secret when it appears. Searchly displays it once. Store it in your server's secret manager or environment; keep it out of browser code, URLs, and source control. This quickstart reads existing resources and does not change your projects.

Find your project

#

Call GET /projects and choose an ID from data.items. Your browser's selected project does not affect API requests.

Project lists return data.pagination. If hasMore is true, increase offset to retrieve the next page. If the list is empty, create a project in the platform or use the project creation endpoint with a write key.

The example response shows relevant fields; project records contain additional configuration fields.

Read a report

#

The visibility endpoint returns a dated series for your project. Supply an inclusive UTC calendar range of up to 366 days. Omitted report dates select the last seven days.

Report payloads include their period, measurement methodology, and any limited nested lists. Existing projects need collected answers to have observed measurement data. A successful response does not mean a provider has produced new answers.

The JavaScript example runs on your server and uses the same environment variables. Keep meta.requestId when reporting a failure. Read pagination and filters before adding a filter or retrieving longer histories.

API documentation