Issues

Search issues

Returns the issues matching every given filter, ranked by full-text relevance when a query is given and by latest sighting otherwise. By default, open issues plus those closed in the last 30 days.

post/v1/issues/search

Request

  • Base URL
    https://docs.grepr.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header GREPR-API-KEY
    • or OpenID Connect (https://grepr-prod.us.auth0.com/.well-known/openid-configuration)

Request body

closedWithinDaysinteger

Include closed issues closed within this many days. Absent: 30 when states is absent, with those closed as IGNORED or NOT_A_PROBLEM kept at any age, and no window when it is given. Given, it's exact.

cursorstring

The nextCursor of the previous page, sent with the same filters.

entitiesobject

Entity tags to match: every key must match, and any of a key's values matches it. Keys and values match in any case. An unprefixed key is put in the entity: namespace.

fingerprintstring

Only issues with exactly this fingerprint.

labelsstring[]

Only issues carrying every one of these labels.

limitinteger

The page size, at most 100; absent: 25.

priority'P0' | 'P1' | 'P2' | 'P3'

Only issues at this priority or more urgent.

querystring

Words to search the whole issue for, comments included, split and stemmed as the issue is, so checkout-api is also checkout and api: an issue matches when it has any one of them, and those with the most, above all in their title, fingerprint and entities, come first.

statesstring[]

Only issues in these states. Absent: open issues plus those closed within closedWithinDays, and, when that is absent too, those closed as IGNORED or NOT_A_PROBLEM at any age.

teamIdsstring[]

Only issues one of these teams can see: linked to one of them, or shared with all teams.

updatedSincestring date-time

Only issues changed at or after this time.

Response

Search results

labelsInUsestring[]

The labels most used on recent issues the caller can see, so a new issue reuses them; on the first page only, null after.

nextCursorstring

Pass back as cursor, with the same filters, for the next page; null on the last page.

truncatedboolean

Whether the search stopped after 500 rows; refine the filters to see the rest.

Changes

No recorded changes to this operation across all 1 revision of this API.