API reference

Content Analysis Filters API

The filterable fields for the content analysis endpoints — field, type, operators, allowed values, which endpoints accept it and whether it is applied upstream or locally. Generated from the adapter's own filter implementation, so it cannot drift. Static, costs no credits.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/content_analysis/filterslive · provenfree

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`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.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/content_analysis/filters" \
  -H "x-api-key: mn_your_key_here"

TypeScript

typescript

const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
  "https://www.monocrawl.com/v1/content_analysis/filters",
  { headers: { "x-api-key": key } },
);
const body = await res.json();

if (!body.success) {
  // one error shape for every endpoint — see /docs/errors
  throw new Error(`${body.error.type}: ${body.error.message}`);
}

console.log(body.data, "credits left:", body.credits_remaining);

Python

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/content_analysis/filters",
    headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
    timeout=60,
)
body = res.json()

if not body["success"]:
    # one error shape for every endpoint — see /docs/errors
    raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")

print(body["data"], "credits left:", body["credits_remaining"])

Response

Response fields and example

This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.

200 · application/json

{
  "success": true,
  "platform": "content_analysis",
  "endpoint": "/v1/content_analysis/filters",
  "data": {
    "_warnings": [
      "example"
    ],
    "count": 0,
    "items": [
      {
        "applies_to": [
          "example"
        ],
        "doc": "example",
        "example": "example",
        "field": "example",
        "operators": [
          "example"
        ],
        "stage": "example",
        "type": "example",
        "values": [
          "example"
        ]
      }
    ],
    "stages": {
      "local": "example",
      "upstream": "example"
    },
    "syntax": "example"
  },
  "credits_used": 0,
  "credits_remaining": 99,
  "request_id": "req_…",
  "cached": false
}

The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.

Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.

Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.

Field inside data	Type	Meaning
`_warnings`	`array \| null`	Optional warnings supplied by this operation. Null means unknown.
`count`	`number \| null`	Number of records in this response, not lifetime or total matches.
`items`	`array \| null`	Returned records. Source coverage and completeness vary.
`items[].applies_to`	`array \| null`	Optional applies to supplied by this operation. Null means unknown.
`items[].doc`	`string \| null`	Optional doc supplied by this operation. Null means unknown.
`items[].example`	`string \| null`	Optional example supplied by this operation. Null means unknown.
`items[].field`	`string \| null`	Optional field supplied by this operation. Null means unknown.
`items[].operators`	`array \| null`	Optional operators supplied by this operation. Null means unknown.
`items[].stage`	`string \| null`	Optional stage supplied by this operation. Null means unknown.
`items[].type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`items[].values`	`array \| null`	Optional values supplied by this operation. Null means unknown.
`stages`	`object \| null`	Optional stages supplied by this operation. Null means unknown.
`stages.local`	`string \| null`	Optional local supplied by this operation. Null means unknown.
`stages.upstream`	`string \| null`	Optional upstream supplied by this operation. Null means unknown.
`syntax`	`string \| null`	Optional syntax supplied by this operation. Null means unknown.

Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.

The example is invented and illustrates types only; zero and empty values are not claims about a real result.

Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference

Content Analysis Filters API

Query parameters

Make the request

Response fields and example

More Content Analysis reference

First call in under a minute