Skip to main content
GET
/
production-reports
Get production reports
curl --request GET \
  --url https://app.colacloud.us/api/v1/production-reports \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "commodity": "<string>",
      "report_type": "<string>",
      "year": 123,
      "month_number": 123,
      "report_date": "2023-12-25",
      "statistical_group": "<string>",
      "statistical_category": "<string>",
      "statistical_detail": "<string>",
      "count_ims": 123,
      "value": 123,
      "value_unit": "<string>",
      "is_redacted": true
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "per_page": 123,
    "has_more": true
  }
}

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header

Query Parameters

commodity
string

Filter by commodity

year
integer

Filter by year

month
integer

Filter by month (1-12)

Required range: 1 <= x <= 12
report_type
string

Filter by report type

statistical_group
string

Filter by statistical group

page
integer
default:1

Page number

Required range: x >= 1
per_page
integer
default:100

Results per page (max 100)

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
meta
object

Response metadata with pagination