LAlatitude-dev
Saved Searches

Create saved search

Changed on

Creates a saved search within the project. At least one of query or filters must be set. The slug is derived from name. OAuth-authenticated only.

post/v1/projects/{projectSlug}/searches

Request

  • Base URL
    https://api.latitude.so
  • Auth
    HTTP bearer

Path parameters

projectSlugstring required

Project slug (human-readable identifier)

Project slug (human-readable identifier). The CLI can also read this from the LATITUDE_PROJECT_SLUG environment variable.

Request body

namestring required

Human-readable name. Used to derive the slug.

querystring nullable

Free-text semantic query. null (default) when the search is filter-only. At least one of query or filters must be set.

filtersobject

Structured filter set. Defaults to {} (no filters). At least one of query or filters must be set.

Response

Saved search created

idstring required

Stable saved-search identifier.

organizationIdstring required

Organization that owns this saved search.

projectIdstring required

Project this saved search belongs to.

slugstring required

URL-safe slug derived from name. Regenerated when the name changes in a way that affects the slug.

namestring required

Human-readable name.

querystring nullable required

Free-text semantic query applied alongside filters. null when the search is filter-only. At least one of query or filters must be set.

filtersobject required

Structured filter set applied alongside query. Empty object means filter-free. At least one of query or filters must be set.

deletedAtstring nullable required

ISO-8601 timestamp at which the search was deleted. null while active.

createdAtstring required

ISO-8601 timestamp of creation.

updatedAtstring required

ISO-8601 timestamp of the last update.

Changes

  • 7564f2e9f4e7Revision changes
    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

  • f43cc7296246Revision changes
    • info

      endpoint added