Get
/ts-integration/data-request/{requestId}
Request type: | GET |
URL: | https://api.solargis.com/ts-integration/data-request/{requestId} |
Authorization: | Bearer {API token} |
Body parameters: | N/A |
This endpoint enables you to obtain sample location data for Time Series data API subscriptions. You can use it to set up your integration to understand the structure and content of the response.
Key points to remember before you proceed:
- You will need an API token and the
requestIdto download sample location data. Learn how to obtain therequestIdfor integration setup purposes in the Integration setup - get the requestId guide. - Calls to the integration API endpoints are free of charge.
- You can test the endpoint and get the response in the API console to the right. Learn how to use the console in the Using the API console guide.
Security
HTTP
Type bearer
Enter your Solargis TimeSeries Bearer token. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
Path parameters
requestId
stringRequired
ExampleBeHpHTBE8y
Responses
200
TimeSeries data retrieved
object
status
string
Valid values[
"success",
"error",
"pending"
]
Examplesuccess
statusCode
string
Pattern^SG2-\d{5}$
ExampleSG2-20000
statusMessage
string
ExampleRequest has been processed.
downloadUrl
string (uri)
Examplehttps://sg2-base-api-prod-apidatabucketa8a36...
401
Ivalid authorization
object
Ivalid authorization
error
string
Exampletoken.invalid
500
Bad requestId
object
error
string
Exampleapi.data_request.not_found