Arize Phoenix TS
    Preparing search index...

    Interface GetTracesParams

    Parameters for getting traces from a project.

    interface GetTracesParams {
        client?: {
            config: PhoenixClientOptions;
            DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
            GET: ClientMethod<paths, "get", `${string}/${string}`>;
            getServerVersion: () => Promise<SemanticVersion>;
            HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
            OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
            PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
            POST: ClientMethod<paths, "post", `${string}/${string}`>;
            PUT: ClientMethod<paths, "put", `${string}/${string}`>;
            request: ClientRequestMethod<paths, `${string}/${string}`>;
            TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
            eject(...middleware: Middleware[]): void;
            use(...middleware: Middleware[]): void;
        };
        cursor?: string
        | null;
        endTime?: string | Date | null;
        error?: boolean | null;
        filter?: string | null;
        includeSpans?: boolean;
        limit?: number;
        maxLatencyMs?: number | null;
        minLatencyMs?: number | null;
        order?: "asc" | "desc";
        project: ProjectIdentifier;
        sessionId?: string | string[] | null;
        sort?: "start_time" | "latency_ms";
        startTime?: string | Date | null;
    }

    Hierarchy (View Summary)

    Index
    client? cursor? endTime? error? filter? includeSpans? limit? maxLatencyMs? minLatencyMs? order? project sessionId? sort? startTime?
    client?: {
        config: PhoenixClientOptions;
        DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
        GET: ClientMethod<paths, "get", `${string}/${string}`>;
        getServerVersion: () => Promise<SemanticVersion>;
        HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
        OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
        PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
        POST: ClientMethod<paths, "post", `${string}/${string}`>;
        PUT: ClientMethod<paths, "put", `${string}/${string}`>;
        request: ClientRequestMethod<paths, `${string}/${string}`>;
        TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
        eject(...middleware: Middleware[]): void;
        use(...middleware: Middleware[]): void;
    }

    An instance of the Phoenix client. If not provided, the client will be created using the default configuration.

    Type Declaration

    • config: PhoenixClientOptions
    • DELETE: ClientMethod<paths, "delete", `${string}/${string}`>

      Call a DELETE endpoint

    • GET: ClientMethod<paths, "get", `${string}/${string}`>

      Call a GET endpoint

    • getServerVersion: () => Promise<SemanticVersion>

      Get the Phoenix server version, returning a cached value if available.

      The version is first populated from the x-phoenix-server-version response header on any API call. If no version has been seen yet, this method fetches GET /arize_phoenix_version to populate the cache.

      If the server version cannot be determined (e.g. the server is unreachable or returned an unparseable version string).

    • HEAD: ClientMethod<paths, "head", `${string}/${string}`>

      Call a HEAD endpoint

    • OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>

      Call a OPTIONS endpoint

    • PATCH: ClientMethod<paths, "patch", `${string}/${string}`>

      Call a PATCH endpoint

    • POST: ClientMethod<paths, "post", `${string}/${string}`>

      Call a POST endpoint

    • PUT: ClientMethod<paths, "put", `${string}/${string}`>

      Call a PUT endpoint

    • request: ClientRequestMethod<paths, `${string}/${string}`>
    • TRACE: ClientMethod<paths, "trace", `${string}/${string}`>

      Call a TRACE endpoint

    • eject: function
      • eject(...middleware: Middleware[]): void

        Unregister middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    • use: function
      • use(...middleware: Middleware[]): void

        Register middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    cursor?: string | null

    Pagination cursor

    endTime?: string | Date | null

    Exclusive upper bound time. Must be a valid ISO 8601 string or Date object.

    error?: boolean | null

    Filter by trace error status. true returns only traces containing at least one errored span, false only traces with no errored spans. Omit to leave traces unfiltered by error status.

    Use filter: "error_count > 0" or filter: "error_count == 0".

    Phoenix server >= 20.8.0

    filter?: string | null

    Trace filter expression, combined with other filters using AND.

    https://arize.com/docs/phoenix/tracing/how-to-tracing/filter-expressions

    Phoenix server >= 20.12.0

    includeSpans?: boolean

    If true, include full span details for each trace

    limit?: number

    Maximum number of traces to return

    maxLatencyMs?: number | null

    Inclusive upper bound on trace latency in milliseconds.

    Use filter: "latency_ms <= N".

    Phoenix server >= 20.8.0

    minLatencyMs?: number | null

    Inclusive lower bound on trace latency in milliseconds.

    Use filter: "latency_ms >= N".

    Phoenix server >= 20.8.0

    order?: "asc" | "desc"

    Sort direction

    project: ProjectIdentifier

    The project to get traces from

    sessionId?: string | string[] | null

    Filter traces by session identifier(s) (session_id strings or GlobalIDs)

    sort?: "start_time" | "latency_ms"

    Sort field

    startTime?: string | Date | null

    Inclusive lower bound time. Must be a valid ISO 8601 string or Date object.

    Settings
    Member Visibility

    On This Page
    Properties