---
title: "Stop a vendor estimation run"
method: POST
path: "/v1/integrations/{integrationId}/exceptions/vendor-estimation-runs/{runId}/stop"
tags: ["Integration Exceptions"]
---

# Stop a vendor estimation run

`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)
- URL: `https://docs.grepr.ai/v1/integrations/{integrationId}/exceptions/vendor-estimation-runs/{runId}/stop`
- Auth: one of:
  - API key in header `GREPR-API-KEY`
  - OpenID Connect (`https://grepr-prod.us.auth0.com/.well-known/openid-configuration`)

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.

## Path parameters

- `integrationId` string, required
- `runId` string, required

## Response `200`

Run stopped

- VendorEstimationRun
  - `createdAt` string, date-time, required: When the run was created
  - `failureReason` string: Why a FAILED run failed
  - `id` string, required: Run id
  - `integrationId` string, required: Integration whose imported exceptions this run estimates
  - `predicatesDone` integer, required: Predicates that have reached a non-pending status
  - `predicatesTotal` integer, required: Distinct predicates in the run, fixed at creation
  - `requestedBy` string: Id of the user who started the run
  - `resumeAfter` string, date-time: When a THROTTLED run will be counted again
  - `scopeQuery` string, 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.
  - `scopeTotalCount` integer: Total events the scope matched over the window, the denominator
  - `state` 'QUEUED' | 'RUNNING' | 'THROTTLED' | 'STOPPED' | 'COMPLETE' | 'FAILED', required: Current run state
  - `stopReason` string: Why a STOPPED run stopped: USER or TIMED_OUT
  - `updatedAt` string, date-time, required: When the run was last written to
  - `vendor` 'DATADOG', required: Vendor whose index the counts were made against
  - `windowEnd` string, date-time, required: Absolute end of the counted window, resolved at creation
  - `windowStart` string, date-time, required: Absolute start of the counted window, resolved at creation

## Other responses

- `401`: Unauthorized
- `404`: Not Found - Integration or run not found.

---

[API](https://skmtc.dev/grepr/apis/grepr-api.md) - [All operations](https://skmtc.dev/grepr/apis/grepr-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grepr/apis/grepr-api/revisions/2a5ce03a0bf0?raw)
