# Cohort Queries API guide



## Choose a Cohort Queries operation



Start with the object your task needs. The groups below use the current catalogue; open an endpoint to check accepted identifiers, filters, price and availability before retrieving.



### Other operations



- [Delete a cohort query](https://www.monocrawl.com/docs/endpoints/cohort-queries/delete) — Delete one of your cohort sweeps and its results. A sweep still queued is cancelled and refunded; one already running is cancelled and its charge stands.

- [Check cohort query status](https://www.monocrawl.com/docs/endpoints/cohort-queries/get) — The status of one cohort keyword sweep, with per-member progress while it runs.

- [Read cohort query results](https://www.monocrawl.com/docs/endpoints/cohort-queries/results) — The keyword matches a finished cohort sweep found, per member, newest page first.



## Check fields and collection limits



Use the endpoint’s declared parameters and returned continuation. Filters from another platform do not automatically apply here. Preserve source identifiers, URLs and warnings; a successful page does not establish complete history. Published response schemas identify whether they come from a reviewed shaper or observed response shapes.



Agents can use `get_endpoint` for the current contract and `get_docs` with topic `platforms/cohort-queries` to read this page. The [coverage guide](https://www.monocrawl.com/docs/data-availability) explains nulls and partial results, and the [production guide](https://www.monocrawl.com/docs/production-checklist) covers budgets and recovery.



## Endpoint reference

## cohort-queries/delete

`GET /v1/cohort-queries/delete`

Delete one of your cohort sweeps and its results. A sweep still queued is cancelled and refunded; one already running is cancelled and its charge stands.

*Delete a cohort query*

| Parameter | Required | Description |
| --- | --- | --- |
| `query_id` | yes | Cohort query id (the {queryId} path segment) — e.g. `cq_0f2c8b1d4e6a7c9b0d1e2f3a` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** free — 0 credits.

```bash
curl "https://www.monocrawl.com/v1/cohort-queries/delete?query_id=cq_0f2c8b1d4e6a7c9b0d1e2f3a" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "id": null,
  "deleted": false,
  "cancelled": {
    "credits_refunded": 0,
    "refund_status": null
  }
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/cohort-queries/delete#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/cohort-queries/delete.json)


## cohort-queries/get

`GET /v1/cohort-queries/get`

The status of one cohort keyword sweep, with per-member progress while it runs.

*Check cohort query status*

| Parameter | Required | Description |
| --- | --- | --- |
| `query_id` | yes | Cohort query id (the {queryId} path segment) — e.g. `cq_0f2c8b1d4e6a7c9b0d1e2f3a` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** free — 0 credits.

```bash
curl "https://www.monocrawl.com/v1/cohort-queries/get?query_id=cq_0f2c8b1d4e6a7c9b0d1e2f3a" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "id": null,
  "cohort_id": null,
  "keyword": null,
  "status": null,
  "job_id": null,
  "error": null,
  "created_at": null,
  "completed_at": null,
  "counts": {},
  "per_member": [],
  "matches": []
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/cohort-queries/get#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/cohort-queries/get.json)


## cohort-queries/results

`GET /v1/cohort-queries/results`

The keyword matches a finished cohort sweep found, per member, newest page first.

*Read cohort query results*

| Parameter | Required | Description |
| --- | --- | --- |
| `query_id` | yes | Cohort query id (the {queryId} path segment) — e.g. `cq_0f2c8b1d4e6a7c9b0d1e2f3a` |
| `cursor` | no | Opaque cursor from the previous page of matches |
| `limit` | no | Matches per page, 1-100 (default 25) — e.g. `25` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `limit`: Bound the returned rows to what your task needs. A smaller limit does not necessarily reduce source calls or price; inspect the quote.
- `cursor`: Continue the same source traversal with the complete returned cursor. Saved-result retrieval and a new source page can have different prices; quote the next call.
- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** free — 0 credits.

```bash
curl "https://www.monocrawl.com/v1/cohort-queries/results?query_id=cq_0f2c8b1d4e6a7c9b0d1e2f3a" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "items": [],
  "count": 0,
  "cursor": null,
  "has_more": false,
  "query_id": null,
  "cohort_id": null,
  "keyword": null,
  "status": null,
  "error": null,
  "completed_at": null,
  "ready": false,
  "total": 0,
  "counts": {},
  "per_member": []
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/cohort-queries/results#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/cohort-queries/results.json)