GRgrepr
Integration Exceptions

Stop a vendor estimation run

Stops the run and keeps every count it has made. A stopped run can be resumed or deleted. A no-op on a run that is not in progress.

post/v1/integrations/{integrationId}/exceptions/vendor-estimation-runs/{runId}/stop

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)

Path parameters

integrationIdstring required

Integration id

runIdstring required

Run id

Response

Run stopped

createdAtstring date-time required

When the run was created

failureReasonstring

Why a FAILED run failed

idstring required

Run id

integrationIdstring required

Integration whose imported exceptions this run estimates

predicatesDoneinteger required

Predicates that have reached a non-pending status

predicatesTotalinteger required

Distinct predicates in the run, fixed at creation

requestedBystring

Id of the user who started the run

resumeAfterstring date-time

When a THROTTLED run will be counted again

scopeQuerystring required

Vendor query limiting the estimate to part of the customer's traffic, applied to both the matched count and the total. Empty means all logs.

scopeTotalCountinteger

Total events the scope matched over the window, the denominator

state'QUEUED' | 'RUNNING' | 'THROTTLED' | 'STOPPED' | 'COMPLETE' | 'FAILED' required

Current run state

stopReasonstring

Why a STOPPED run stopped: USER or TIMED_OUT

updatedAtstring date-time required

When the run was last written to

vendor'DATADOG' required

Vendor whose index the counts were made against

windowEndstring date-time required

Absolute end of the counted window, resolved at creation

windowStartstring date-time required

Absolute start of the counted window, resolved at creation

Example response

{
  "id": "0q841q0j81m2q",
  "integrationId": "0q841q0j81m2q",
  "requestedBy": "user-1",
  "scopeQuery": "service:broker-* AND env:prod"
}

Changes

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