Client methods

Public methods

client.query(query, options?: { limit?: number; signal?: AbortSignal }): Promise<JqlQueryResponse>
client.present(presentation, options?: { limit?: number; signal?: AbortSignal }): Promise<JqlPresentationResponse>
client.discover(kind, options?: DiscoveryOptions & JqlRequestOptions): Promise<JqlQueryResponse>

Method	Accepted query	Endpoint behavior	Returns
`query`	Source query, pipeline, or discovery query	Executes structured JQL	`JqlQueryResponse`
`present`	A `.table(...)` or `.chart(...)` result	Executes the wrapped query and projects a renderer-neutral frame	`JqlPresentationResponse`
`discover`	A documented discovery kind plus kind-specific options	Builds a discovery IR object, then delegates to `query`	`JqlQueryResponse`

Request option: `limit`

limit is an integer from 1 through 10,000, validated by the public API. When omitted, the SDK sends 10,000.

The request-envelope limit replaces any limit inside the JQL object — it is not a min(). Because the public API always sends one, an inner .rows(... limit ...) of 100 is widened to 10,000 unless you also set the method-level limit.
Set the method-level limit whenever you want a smaller result.
The envelope limit is ignored for terminals that do not produce a limitable result, such as count and agg.
client.discover forwards its limit only as the request cap. To set the IR-level discovery limit, build the discovery object directly and pass it to client.query.
An out-of-range limit is rejected as a 400 with error Validation failed, not BAD_QUERY.
signal is passed to fetch as an AbortSignal.

Transport

The SDK sends:

{
  "query": { "op": "query", "source": "traces", "select": { "op": "ids" } },
  "limit": 100
}

to the project-scoped query endpoint. present uses a separate /query/presentation endpoint; discover shares the query endpoint. The SDK supplies Authorization: Bearer <api key>, the X-Organization-Id header, and the resolved project ID as a path parameter. The public response never includes compiled SQL — it is stripped at the API boundary.

Use Responses and errors for the exact success and failure shapes.

Client methods

Public methods

Request option: limit

Transport

On this page

Request option: `limit`