New Data Constraints & Data Access Limits Based on the Chosen Tier/Package
Below you will find information on how to interact with our key API endpoints, along with possible error messages you may encounter and the corresponding constraints and data access limits.
API Access Packages and Tiers
Stations
Package 1: Up to 10 stations
Package 2: 11 to 100 stations
Package 3: More than 100 stations
API Calls
Tier 1: Up to 48 requests per station/day
Tier 2: Up to 500 requests per station/day
Tier 3: Up to 1500 requests per station/day
Data Access Limits
Tier 1: Last 30 days
Tier 2: Last 365 days
Tier 3: Full historical data (10 years)
Data Access Limits per API Call
Raw data: Last 7 days
Hourly/Daily Aggregation: Last 30 days
Monthly Aggregation: As per tier
Base URL
https://api.fieldclimate.com/v2
Placeholders
`{deviceId}`: Replace this with the unique identifier of the device.
`{startTime}`: Replace this with the start time in Unix timestamp format.
`{endTime}`: Replace this with the end time in Unix timestamp format.
`{interval}`: Replace this with the desired interval duration e.g., (1,2,3 etc).Accessing Historical Data
Raw Data
Endpoint: `/data/{deviceId}/raw/from/{startTime}/to/{endTime}`
Error Code: 403
Message: `Search history access is limited to {data-access-limit} days from today`
Hourly Data
Endpoint: `/data/{deviceId}/raw/from/{startTime}/to/{endTime}`
Error Code: 403
Message: `Search history access is limited to {data-access-limit} days from today`
Daily Data
Endpoint: `/data/{deviceId}/daily/from/{startTime}/to/{endTime}`
Error Code: 403
Message: `Search history access is limited to {data-access-limit} days from today`
Monthly Data
Endpoint: `/data/{deviceId}/monthly/from/{startTime}/to/{endTime}`
Error Code: 403
Message: `Search history access is limited to {data-access-limit} days from today`
Accessing Recent Data
Raw Data
Endpoint: `/data/{deviceId}/raw/last/{interval}`
Error Code: 403
Message: `The interval limit for the data group 'raw' is 7 days.`
Data Access Limit: Last 7 days
Hourly Data
Endpoint: `/data/{deviceId}/hourly/last/{interval}`
Error Code: 403
Message: `The interval limit for the data group 'hourly' is 30 days.`
Data Access Limit: Last 30 days
Daily Data
Endpoint: `/data/{deviceId}/daily/last/{interval}`
Error Code: 403
Message: `The interval limit for the data group 'daily' is 30 days.`
Data Access Limit: Last 30 days
Monthly Data
Endpoint: `/data/{deviceId}/monthly/last/{interval}`
Error Code: 403
Message: `The interval limit for the data group 'monthly' is 3650 days.`
Data Access Limit: As per tier (Tier 1: Last 30 days, Tier 2: Last 365 days, Tier 3: Full historical data - 10 Years)
Note: The rules and constraints mentioned above also apply to our other endpoints which either accept device-id or date or both parameters, listed in our current documentation available at the following links: - https://api.fieldclimate.com/v2/docs/ - https://docsdev.fieldclimate.com/ However we are currently in the process of revamping our main documentation. We appreciate your patience during this time. For any issues, clarifications, or further assistance, please don't hesitate to reach out to us at [email protected]. Thank you for your understanding and cooperation!