Warning
The YCharts API is available to our API customers for their internal use only. Any redistribution or commercial use of data from the API is strictly prohibited without prior written consent from YCharts. For more details on our API’s capabilities and pricing please contact sales@ycharts.com or call (866) 965-7552.
Indicator Report Releases¶
The Indicator Report Releases Endpoint is used to obtain information about one or more indicator reports.
Request Info¶
Request Method |
GET |
URL |
/v3/indicator_reports/ |
Request Parameters¶
Parameter |
Required |
Description |
---|---|---|
id[s] |
Y |
Unique id for an indicator report, or a comma separated list of ids |
start_date |
N |
The first date of the desired data range, defaults to one day ago |
end_date |
N |
The last date of the desired data range, defaults to today |
Note
There is a maximum of 100 indicator reports per request
Response Info¶
The response will contain one or more indicator report objects. The key for each indicator report object is the id passed in the request.
Field |
Type |
Description |
---|---|---|
meta |
Meta |
This object contains information about the query for the indicator report object |
results |
Results |
This object contains the results of the query |
Field |
Type |
Description |
---|---|---|
data |
Array |
An array of Indicator Report Release objects |
meta |
Meta |
This object contains information about the query for the data |
Field |
Type |
Description |
---|---|---|
is_revision |
Boolean |
Whether new data was released, or data was only revised |
reference_period |
Date |
The period which the data in the release references |
release_date |
Datetime |
The date and time at which the report was released |
Examples¶
The following is an example successful response
Request URL
https://api.ycharts.com/v3/indicator_reports/268/releases?start_date=2013-06-01&end_date=2013-12-31
Response
{
"meta": {
"status": "ok",
"url": "https://api.ycharts.com/v3/indicator_reports/268/releases?start_date=2013-06-01&end_date=2013-12-31"
},
"response": {
"268": {
"meta": {
"status": "ok"
},
"results": {
"data": [
{
"is_revision": false,
"reference_period": "2013-12-18",
"release_date": "2013-12-18T19:00"
},
{
"is_revision": false,
"reference_period": "2013-10-30",
"release_date": "2013-10-30T18:00"
},
{
"is_revision": false,
"reference_period": "2013-09-18",
"release_date": "2013-09-18T18:00"
},
{
"is_revision": false,
"reference_period": "2013-07-31",
"release_date": "2013-07-31T18:00"
},
{
"is_revision": false,
"reference_period": "2013-06-19",
"release_date": "2013-06-19T18:00"
}
],
"meta": {
"status": "ok"
}
}
}
}
}