/fedstat/indicators

POST /api/fedstat/indicators

Price: 5 credits

Get one EMISS statistical indicator by its id: passport, publishing agency and dimension catalogue

How to use it

Call this before fetching observations: it lists every dimension of the indicator with the value ids and Russian labels that the data endpoint accepts, so do not invent dimension codes. An indicator that never carried data still has a passport here but comes back with no dimensions, so read has_data instead of assuming observations exist. An unapproved indicator is always refused; a retired one is refused only when it once carried data, so a retired indicator that never did still answers with its passport.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• indicator_id integer required — EMISS indicator identifier (examples: 41003, 43230, 62731; min: 1)

Response

• @type string (default: "FedstatIndicator")
• id integer required
• url string required
• name string required
• organization string (default: "")
• department string (default: "")
• sections array (default: [])
  • @type string (default: "FedstatIndicatorSection")
  • id string required
  • name string required
• themes array (default: [])
• gov_programs array (default: [])
• exclusion_note string (default: "")
• methodology string (default: "")
• comment string (default: "")
• contact object nullable
  • @type string (default: "FedstatIndicatorContact")
  • name string (default: "")
  • phone string (default: "")
  • email string (default: "")
• periodicity array (default: [])
  • @type string (default: "FedstatIndicatorPeriodicity")
  • name string required
  • characteristic string (default: "")
  • submission string (default: "")
• units array (default: [])
• classifiers array (default: [])
• source_method string (default: "")
• source_forms array (default: [])
  • @type string (default: "FedstatIndicatorForm")
  • id string required
  • name string required
  • url string required
• valid_from_date string (default: "")
• valid_to_date string (default: "")
• series_start_year integer nullable
• series_end_year integer nullable
• last_update_date string (default: "")
• has_data boolean (default: false)
• dimensions array (default: [])
  • @type string (default: "FedstatDimension")
  • id string required
  • name string required
  • values array (default: [])
    • @type string (default: "FedstatDimensionValue")
    • id string required
    • name string required
    • code string (default: "")
    • is_default boolean (default: false)

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 — fedstat.ru never began sending this indicator's page. A few indicators behave this way, and some of them answer on a later call, so retry once before treating the indicator as unavailable. 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 — No such indicator id, or fedstat.ru serves this one only to signed-in users. 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.