% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/metadata.R
\name{dashboard_indicators}
\alias{dashboard_indicators}
\title{Search and retrieve indicator metadata}
\usage{
dashboard_indicators(
  query = NULL,
  indicator_code = NULL,
  category = NULL,
  time = NULL,
  time_from = NULL,
  time_to = NULL,
  cycle = NULL,
  regional_rank = NULL,
  seasonal = NULL,
  stat_code = NULL,
  stat_name = NULL,
  modified_from = NULL,
  modified_to = NULL,
  lang = dash_default("lang", "en"),
  timeout = dash_default("timeout", 30),
  retries = dash_default("retries", 3)
)
}
\arguments{
\item{query}{Optional partial match for the indicator name.}

\item{indicator_code}{Optional vector of 19-digit indicator codes. Up to 50
codes can be sent in one metadata request.}

\item{category}{Optional Statistics Dashboard category code.}

\item{time, time_from, time_to}{Optional eight-character API time codes, such
as \code{"20240100"}, \code{"20241Q00"}, \code{"2024CY00"}, or \code{"2024FY00"}.}

\item{cycle}{Data cycle: \code{"month"}, \code{"quarter"}, \code{"year"}, or
\code{"fiscal_year"}; API codes 1--4 are also accepted.}

\item{regional_rank}{One of \code{"country"}, \code{"japan"}, \code{"prefecture"}, or
\code{"municipality"}; API codes 1--4 are also accepted.}

\item{seasonal}{\code{"original"} or \code{"seasonally_adjusted"}; API codes 1 and 2
are also accepted.}

\item{stat_code, stat_name}{Optional statistical survey code or partial name.}

\item{modified_from, modified_to}{Optional metadata update dates in
\code{YYYYMMDD} format.}

\item{lang}{Response language, \code{"en"} or \code{"jp"}.}

\item{timeout}{Request timeout in seconds.}

\item{retries}{Number of retries for transient failures.}
}
\value{
A tibble with one row per indicator element.
}
\description{
This is the discovery endpoint for Statistics Dashboard series. The result
has one row per indicator element: an indicator split by data cycle,
regional rank, and original/seasonally adjusted status.
}
\examples{
\dontrun{
dashboard_indicators(query = "Total population", lang = "en")
dashboard_indicators(
  category = "0201", cycle = "year", regional_rank = "prefecture"
)
}
}
