curl -H "X-API-Key: $PARTICLE_API_KEY" \
"https://api.particle.pro/v1/podcasts/{id}/ratings/summary"{
"entries": [
{
"computed_at": "2023-11-07T05:31:56Z",
"histogram": {
"stars_1": 123,
"stars_2": 123,
"stars_3": 123,
"stars_4": 123,
"stars_5": 123
},
"platform_slug": "<string>",
"rating_average": 123,
"rating_count": 123,
"locale": "<string>"
}
],
"podcast_id": "<string>",
"combined": {
"computed_at": "2023-11-07T05:31:56Z",
"histogram": {
"stars_1": 123,
"stars_2": 123,
"stars_3": 123,
"stars_4": 123,
"stars_5": 123
},
"platform_slug": "<string>",
"rating_average": 123,
"rating_count": 123,
"locale": "<string>"
},
"sentiment": {
"generated_at": "2023-11-07T05:31:56Z",
"rating_count_in_window": 123,
"summary_text": "<string>",
"locale": "<string>",
"platform_slug": "<string>",
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z"
}
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Summarize a podcast's ratings
Returns the numeric aggregate of a podcast’s ratings — one entry per (platform, locale) it has been rated on, a combined cross-source roll-up, and the latest LLM-generated narrative summary of recent review text when one has been generated.
curl -H "X-API-Key: $PARTICLE_API_KEY" \
"https://api.particle.pro/v1/podcasts/{id}/ratings/summary"{
"entries": [
{
"computed_at": "2023-11-07T05:31:56Z",
"histogram": {
"stars_1": 123,
"stars_2": 123,
"stars_3": 123,
"stars_4": 123,
"stars_5": 123
},
"platform_slug": "<string>",
"rating_average": 123,
"rating_count": 123,
"locale": "<string>"
}
],
"podcast_id": "<string>",
"combined": {
"computed_at": "2023-11-07T05:31:56Z",
"histogram": {
"stars_1": 123,
"stars_2": 123,
"stars_3": 123,
"stars_4": 123,
"stars_5": 123
},
"platform_slug": "<string>",
"rating_average": 123,
"rating_count": 123,
"locale": "<string>"
},
"sentiment": {
"generated_at": "2023-11-07T05:31:56Z",
"rating_count_in_window": 123,
"summary_text": "<string>",
"locale": "<string>",
"platform_slug": "<string>",
"window_end": "2023-11-07T05:31:56Z",
"window_start": "2023-11-07T05:31:56Z"
}
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}{
"detail": "Property foo is required but is missing.",
"error_code": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"resolve": {
"message": "<string>",
"action": "<string>",
"endpoint": "<string>",
"method": "<string>",
"url": "<string>"
},
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Authorizations
Pass your API key in the X-API-Key header (recommended).
Path Parameters
Podcast slug, internal ID, or numeric iTunes ID.
Response
OK
One entry per (platform, locale) the podcast has been rated on.
Show child attributes
Show child attributes
Internal podcast ID.
Single roll-up across every entry, computed by weighting each entry's average by its rating_count. Null when the podcast has no ratings yet.
Show child attributes
Show child attributes
Latest LLM-generated narrative summary. Null until enough ratings have accumulated for the popularity-bucket cadence to generate one.
Show child attributes
Show child attributes
Was this page helpful?