Reference

This page lists every enum, shared filter convention, and error code used across the SE Visible API. Other pages link here instead of repeating values.

All endpoints are served from the base URL https://api.seranking.com/v1/se-visible.

AI models

Values accepted by model_type, model_types, and model.

Sentiment

Values returned by sentiment in results and accepted by the sentiments filter.

Project status

Values returned by status on a project. A new project is processed asynchronously, so poll the project until it reaches success or error.

Country codes

ISO 3166-1 alpha-2 codes accepted by country_code (project creation) and the country_codes filter.

US, UK, CA, FR, DE, NL, ES, AT, BE, AU, NZ, IT, JP, KR, SG, IN, AE, BR, MX, CH, DK, SE, NO, FI, IE, IS, LU, PT, HK, TH, MY, ID, PH, IL, AR, CL, CO, ZA, CZ, GR, TR, PL

Language codes

ISO 639-1 codes accepted by lang_code.

en, fr, de, nl, es, it, ja, ko, hi, ar, pt, da, sv, nb, fi, ga, is, lb, zh, th, ms, id, tl, he, af, cs, el, tr, pl

Source type

Values accepted by source_type on the Sources endpoint. The chosen value changes the shape of each Sources response row.

URL category types

Values accepted by the types filter, used to filter sources by the kind of page cited. The detailed subtypes detected from page content come first, followed by the base types detected from the URL.

Brand match mode

Values accepted by brand_match_mode, used together with the brand_ids filter on Sources.

Prompt list grouping

Values accepted by group_mode on List prompts or topics.

Brand metrics dimensions and metrics

The brand metrics endpoint takes dimensions[] (how rows are grouped) and metrics[] (which values to return). The last dimension is always the pivot.

Dimensions (dimensions[], 1 to 3, last is the pivot)

check_week and check_month cannot be combined with another date dimension (check_id, check_date, check_week, check_month); doing so returns a 422.

Metrics (metrics[], 17 metrics, max 15 per request)

In these metrics, “answers” are the answers of the row that name at least one brand.

aio_overlap and aio_presence are brand-agnostic: they are aggregated over all prompt results of the group, not only the responses that mention a tracked brand, so they stay constant across the brand pivot. Sorting by these metrics is not supported.

Sort fields

Prompt list (sort_field)

A prompt or topic with no source_presence or organic_overlap value in the period (no answers, no AI Overview) stays last in either sort direction, as it does under their _delta variants.

Source (source_sort_field)

The accepted values depend on source_type; a value outside the set for the current source_type returns a 422 validation error. Delta variants (<metric>_delta) sort by the absolute change between periods (period 0 minus period 1) and require date_range[1]; without it the request is rejected with a 422.

For source_type=domain and source_type=subdomain:

For source_type=url:

Sort order (sort_order)

Date ranges and compare mode

Metrics, prompt results, and sources are filtered by a required date_range. It is a deep object with a base period at index 0 and an optional compare period at index 1. Each period has from and to in YYYY-MM-DD.

# Base period only

?date_range[0][from]=2026-05-01&date_range[0][to]=2026-05-31

# Base period vs compare period (compare mode)

?date_range[0][from]=2026-05-01&date_range[0][to]=2026-05-31&date_range[1][from]=2026-04-01&date_range[1][to]=2026-04-30

When a compare period is supplied and contains checks, supported metrics return both period values (period 0 first) plus a delta with absolute and percentage. The delta is present only in compare mode. Any value, including delta.absolute and delta.percentage, may be null when a period has no data and the metric has no meaningful zero baseline.

Array parameters

Most array filters repeat the parameter key, one entry per value:

?model_types=chatgpt&model_types=google_ai_overview

The brand metrics endpoint uses the bracketed array form for dimensions[] and metrics[]:

?dimensions[]=topic_id&metrics[]=visibility_score

Note:

• When a URL contains brackets ([]), pass --globoff to curl so it does not try to interpret them as glob patterns.

Pagination

List endpoints accept limit and offset and return a total count alongside the results.

To page through results, increase offset by limit until offset reaches total.

Error codes

The API uses standard HTTP status codes. Only 2xx responses indicate success. Error bodies are JSON. Endpoint-specific errors are described within each endpoint’s documentation.

Authentication

Every request is authenticated with your SE Ranking API key, the same key used by the Data API and Project API. Send it one of two ways:

• Authorization header (recommended): Authorization: Token YOUR_API_KEY
• Query parameter: ?apikey=YOUR_API_KEY