/federalregister/documents/facets

POST /api/federalregister/documents/facets

Price: 1 credit

Aggregated Federal Register document counts grouped by a facet

How to use it

Get aggregated counts of US Federal Register documents grouped by a facet: time period (daily, weekly, monthly, quarterly, yearly), agency, topic, type, subtype or section. Accepts the same keyword and filter set as document search to narrow the data before aggregating. Returns each facet value with its display name and document count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• facet string required — Facet to aggregate document counts by (one of: "daily", "weekly", "monthly", "quarterly", "yearly", "agency", "topic", "type", "subtype", "section")
• term string nullable — Full-text search keyword to narrow the aggregation
• type array nullable — Filter by document type (one of: "RULE", "PRORULE", "NOTICE", "PRESDOCU")
• agencies array nullable — Filter by agency slug(s)
• agency_ids array nullable — Filter by numeric agency id(s)
• topics array nullable — Filter by topic / CFR indexing term(s)
• sections array nullable — Filter by Federal Register section (one of: "money", "environment", "world", "science-and-technology", "business-and-industry", "health-and-public-welfare")
• publication_date_gte string nullable — Earliest publication date, inclusive (MM/DD/YYYY)
• publication_date_lte string nullable — Latest publication date, inclusive (MM/DD/YYYY)
• publication_date_year integer nullable — Publication year
• significant boolean nullable — Only documents deemed significant

Response

• @type string (default: "FederalregisterFacetBucket")
• value string required
• name string nullable
• 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.