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

GET/v1/content_analysis/rating-distributionlive · proven3 credits
Try in Playground

Parameters

Query parameters

NameRequiredDescriptionExample
keywordyesName of a rateable entity — currently an App Store appSpotify
countryno2-letter App Store storefront (default us); filters=location_code:eq:gb works toous
depthnoPages of up to 50 reviews to sample (max 5)3
filtersnoOnly location_code applies here — see /v1/content_analysis/filterslocation_code:eq:gb
dry_runnoRead 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/rating-distribution?keyword=Spotify" \
  -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/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
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.

200 · application/json
{
  "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 dataTypeMeaning
_warningsarray | nullOptional warnings supplied by this operation. Null means unknown.
distributionarray | nullOptional distribution supplied by this operation. Null means unknown.
distribution[].countnumber | nullNumber of records in this response, not lifetime or total matches.
distribution[].ratingnumber | nullSource rating; read its accompanying scale and vote count.
distribution[].sharenumber | nullOptional share supplied by this operation. Null means unknown.
filters_appliedarray | nullSource array was empty in the reviewed captures; item fields remain unspecified.
histogramobject | nullOptional histogram supplied by this operation. Null means unknown.
keywordstring | nullOptional keyword supplied by this operation. Null means unknown.
mean_ratingnumber | nullOptional mean rating supplied by this operation. Null means unknown.
resolved_entityobject | nullOptional resolved entity supplied by this operation. Null means unknown.
resolved_entity.developerstring | nullOptional developer supplied by this operation. Null means unknown.
resolved_entity.exact_name_matchboolean | nullOptional exact name match supplied by this operation. Null means unknown.
resolved_entity.idstring | nullSource identifier. Preserve the supplied type and exact value.
resolved_entity.namestring | nullOptional name supplied by this operation. Null means unknown.
resolved_entity.search_ranknumber | nullOptional search rank supplied by this operation. Null means unknown.
resolved_entity.typestring | nullOptional type supplied by this operation. Null means unknown.
resolved_entity.urlstring | nullOriginal source URL when supplied.
reviews_samplednumber | nullOptional reviews sampled supplied by this operation. Null means unknown.
sourcesarray | nullOptional sources supplied by this operation. Null means unknown.
sources[].endpointstring | nullOptional endpoint supplied by this operation. Null means unknown.
sources[].okboolean | nullOptional ok supplied by this operation. Null means unknown.
sources[].returnednumber | nullOptional returned supplied by this operation. Null means unknown.
sources[].sourcestring | nullOptional source supplied by this operation. Null means unknown.
sources_unavailablearray | nullOptional sources unavailable supplied by this operation. Null means unknown.
sources_unavailable[].reasonstring | nullOptional reason supplied by this operation. Null means unknown.
sources_unavailable[].sourcestring | nullOptional source supplied by this operation. Null means unknown.
store_reportedobject | nullOptional store reported supplied by this operation. Null means unknown.
store_reported.average_ratingnumber | nullOptional average rating supplied by this operation. Null means unknown.
store_reported.notestring | nullOptional note supplied by this operation. Null means unknown.
store_reported.rating_countnumber | nullOptional rating count supplied by this operation. Null means unknown.
storefrontstring | nullOptional 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

First call in under a minute

1,000 monthly free credits and a ready-made key the moment you sign up. No card.