LAlatitude-dev
Sessions

Get session signal

Changed on

Returns one signal by slug, including its scoreEvidence and occurrence stats scoped to the session. Returns 404 when the signal has no occurrences in the session.

get/v1/projects/{projectSlug}/sessions/{sessionId}/signals/{signalSlug}

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.

sessionIdstring required

Session identifier lifted from instrumentation. Up to 128 characters.

signalSlugstring required

Signal slug.

Response

Session signal

idstring required

Stable signal identifier.

organizationIdstring required

Organization that owns this signal.

projectIdstring required

Project this signal belongs to.

slugstring required

URL-safe slug derived from name. Unique within the project.

namestring required

Human-readable name.

descriptionstring required

Description of the signal.

source'annotation' | 'flagger' | 'custom' required

Where the signal originated from.

statesstring[] required

Active lifecycle states. A signal may carry multiple states at once (e.g. escalating + new).

resolvedAtstring nullable required

ISO-8601 timestamp at which the signal was resolved, or null.

ignoredAtstring nullable required

ISO-8601 timestamp at which the signal was ignored, or null.

regressedAtstring nullable required

ISO-8601 timestamp at which a new occurrence reopened the resolved signal, or null.

mutedAtstring nullable required

ISO-8601 timestamp at which notifications were muted, or null. Muting only silences notifications; incidents still open.

createdAtstring required

ISO-8601 timestamp of creation.

updatedAtstring required

ISO-8601 timestamp of the last update.

occurrencesinteger required

Number of occurrences within the session.

firstSeenAtstring required

ISO-8601 timestamp of the earliest occurrence in the session.

lastSeenAtstring required

ISO-8601 timestamp of the latest occurrence in the session.

traceIdsstring[] required

Traces of the session where the signal occurred.

Changes

  • cdfa10f14027Revision changes
    • info

      added the required property to the response with the status

  • a74967b6b972Revision changes
    • warning

      added the new ignored enum value to the / response property for the response status

    • warning

      added the new regressed enum value to the / response property for the response status

    • warning

      added the new resolved enum value to the / response property for the response status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status