Content Analysis API
Keyword rating distribution
Real 1-5 star histogram for a keyword that resolves to an App Store app, built from actual published reviews plus Apple's own lifetime average. If the keyword resolves to nothing rateable it returns 404 — no histogram is ever synthesised.
Endpoint
/v1/content_analysis/rating-distributionlive · proven3 creditsParameters
Query parameters
| Name | Required | Description | Example |
|---|---|---|---|
keyword | yes | Name of a rateable entity — currently an App Store app | Spotify |
country | no | 2-letter App Store storefront (default us); filters=location_code:eq:gb works too | us |
depth | no | Pages of up to 50 reviews to sample (max 5) | 3 |
filters | no | Only location_code applies here — see /v1/content_analysis/filters | location_code:eq:gb |
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 "https://www.monocrawl.com/v1/content_analysis/rating-distribution?keyword=Spotify" \ -H "x-api-key: mn_your_key_here"
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/rating-distribution?keyword=Spotify",
{ 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
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/content_analysis/rating-distribution?keyword=Spotify",
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.
{
"success": true,
"platform": "content_analysis",
"endpoint": "/v1/content_analysis/rating-distribution",
"data": {
"_warnings": [
"example"
],
"distribution": [
{
"count": 0,
"rating": 0,
"share": 0
}
],
"filters_applied": [],
"histogram": {},
"keyword": "example",
"mean_rating": 0,
"resolved_entity": {
"developer": "example",
"exact_name_match": false,
"id": "example",
"name": "example",
"search_rank": 0,
"type": "example",
"url": "https://example.com/example"
},
"reviews_sampled": 0,
"sources": [
{
"endpoint": "example",
"ok": false,
"returned": 0,
"source": "example"
}
],
"sources_unavailable": [
{
"reason": "example",
"source": "example"
}
],
"store_reported": {
"average_rating": 0,
"note": "example",
"rating_count": 0
},
"storefront": "example"
},
"credits_used": 3,
"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. |
distribution | array | null | Optional distribution supplied by this operation. Null means unknown. |
distribution[].count | number | null | Number of records in this response, not lifetime or total matches. |
distribution[].rating | number | null | Source rating; read its accompanying scale and vote count. |
distribution[].share | number | null | Optional share supplied by this operation. Null means unknown. |
filters_applied | array | null | Source array was empty in the reviewed captures; item fields remain unspecified. |
histogram | object | null | Optional histogram supplied by this operation. Null means unknown. |
keyword | string | null | Optional keyword supplied by this operation. Null means unknown. |
mean_rating | number | null | Optional mean rating supplied by this operation. Null means unknown. |
resolved_entity | object | null | Optional resolved entity supplied by this operation. Null means unknown. |
resolved_entity.developer | string | null | Optional developer supplied by this operation. Null means unknown. |
resolved_entity.exact_name_match | boolean | null | Optional exact name match supplied by this operation. Null means unknown. |
resolved_entity.id | string | null | Source identifier. Preserve the supplied type and exact value. |
resolved_entity.name | string | null | Optional name supplied by this operation. Null means unknown. |
resolved_entity.search_rank | number | null | Optional search rank supplied by this operation. Null means unknown. |
resolved_entity.type | string | null | Optional type supplied by this operation. Null means unknown. |
resolved_entity.url | string | null | Original source URL when supplied. |
reviews_sampled | number | null | Optional reviews sampled supplied by this operation. Null means unknown. |
sources | array | null | Optional sources supplied by this operation. Null means unknown. |
sources[].endpoint | string | null | Optional endpoint supplied by this operation. Null means unknown. |
sources[].ok | boolean | null | Optional ok supplied by this operation. Null means unknown. |
sources[].returned | number | null | Optional returned supplied by this operation. Null means unknown. |
sources[].source | string | null | Optional source supplied by this operation. Null means unknown. |
sources_unavailable | array | null | Optional sources unavailable supplied by this operation. Null means unknown. |
sources_unavailable[].reason | string | null | Optional reason supplied by this operation. Null means unknown. |
sources_unavailable[].source | string | null | Optional source supplied by this operation. Null means unknown. |
store_reported | object | null | Optional store reported supplied by this operation. Null means unknown. |
store_reported.average_rating | number | null | Optional average rating supplied by this operation. Null means unknown. |
store_reported.note | string | null | Optional note supplied by this operation. Null means unknown. |
store_reported.rating_count | number | null | Optional rating count supplied by this operation. Null means unknown. |
storefront | string | null | Optional storefront 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