/politico/facets

POST /api/politico/facets

Price: 1 credit

List the filter values POLITICO files its stories under: the policy sections, the topic, country and person tags with their identifiers, the author identifiers and the post types. Each value carries how many stories currently sit behind it, busiest first within each kind.

How to use it

List the POLITICO filter values. count caps how many values come back and kinds narrows to one or more of section, tag, author and post_type; ask for one kind at a time when you want a deep list of that kind. Each item has kind, value, name and article_count, busiest first within a kind. Feed value into politico/articles/search: section values go into sections, tag values into tag_ids, author values into author_ids and post_type values into post_types. Author values carry a null name — the index facets authors by identifier only — so read the author name off the authors[] of any story the id returns.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• kinds array nullable — Restrict to these kinds of filter value (one of: "section", "tag", "author", "post_type"; examples: ["tag"])
• count integer required — Max number of filter values to return (min: 1)

Response

• @type string (default: "PoliticoFacetValue")
• kind string required
• value string required
• name string nullable
• article_count integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.