Querying DescribeExport API
Query Request
When the DescribeExport GQL query is executed, an S3 signed URL of the requested file is returned with its expiration time, if available, otherwise a 404 response is returned. Argument: The DescribeExport query takes four arguments: customer, year, month, and type (e.g., “telemetry”). These parameters specify the customer and the time period for which the export data is being requested.
Query Response
Query Response for describeExport Example Response single and multiple signed url response are provided below.
API Limits and Usage
Each user is currently allowed up to 100 requests per second. If this limit is exceeded, ADA will respond with an HTTP 429 Too Many Requests status code. To manage and mitigate potential exploits, WAF (Web Application Firewall) rules are in place. API consumption is monitored through usage plans associated with each customer’s API key. At present, there are no quota limits based on usage.
Additionally, you can view the Querying DescribeExport API for Multiple Signed URL Response secion.
QUERY
query DescribeExport {
describeExport(
customer: "cib",
day: 1,
hour: 0,
month: 2,
year: 2023,
format: "parquet",
type: "telemetry"
) {
location
expires
statusCode
}
}
Single Signed URL Response
{
"data": {
"describeExport": {
"location": "https://cib-customer-data-external.s3.amazonaws.com/data/year%3D2023/month%3D01/day%3D01/cib-telemetry-2023-02-01-00-01.parquet?AWSAccessKeyId=ASIA6K5QIROC2WBTZ6UH&Signature=FlKDpSELIEp%2BSliWR7ppmMN8oOs%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEFAaCXVzLWVhc3QtMSJIMEYCIQDYg74nSQHDgAPHLKCjV7iCpyQtKTtQFgbceGWKVhyoNgIhAKi2zl8BrzmnTfTh9NRqhWLCtY1E6zcVgtfTlrkM5SasKqUDCGkQABoMOTg1NTI3NzgyMjc3IgxoOPIVp9VTxKhlttwqggMnnVJPXro6kwQrZ0AM%2Baf6ZSDGQz6W8JX40l1cFiGo1e1OrR%2FTGlWpOJewZuPvUtRKUP4X7CyKBkY9SpUcljtGBU2Rk%2Fxo60CeuT33CldbuK9LzxA1j8ZIn%2B53zp4Z0KlgIXojsQDOpPKLYwmLdTU2ya1cR6tbY%2FzyF2c6ECW2abdysC59n3WR6ugtb84AT%2FS4mbOBZCsYsJ1nqIgHt1gxn8RE%2BjWfsSjv6ZaXAoI6yz81HAsLji7W4003zdxkOkQonccOkDQ3J%2BOlW1a%2BBJMI2QQvna4zCmwHwrzVn9bdp9qmt3thcJYtbHU3H7XC6lBkSKJYBej4JfEqZEtoVX43uNJDfzxhMK%2F%2F0bc1lc0BQJPJjmsVLyM8PgzIjDbb2DP2s2Y6kJC167E%2FuVYzCrKAcCqJVUfw4PZ%2BqpiI5GPtmC1rNqAxjxWjEEhEqkZhpZhQ3p0mSKsR2t0Ee5eeWQ5%2BSGiH%2FwUVeaKYfl1lLQAXVe4Qt6oh2wIjj4RPivJCQndPxjCtiOaiBjqcARLxmRoGu76yG7cfCwo6Z%2FBnrPMQik8O0k7LqgQFFvEJ5CExcs7b8A1U0FgGzaP72fhpcbE1IbY%2FlsVa3pmq2bFndebDHeKEk%2FXpSBFFSZfdrzMzi0CVlccc8iY8lZ62bFz5yFZY2OJWnmPmOXmtcdA44EWAeio9Xj16rCJKU3J4VkFS9lhBNWh31IVGHBeZOsPbwz4l3tmgEq6bWQ%3D%3D&Expires=1683588809",
"expires": "2023-05-08T23:33:29.934500Z",
"statusCode": 200
}
}
}