Skip to main content

​
GET /resources/wrappers/

Retrieve detailed information about a specific wrapper by its ID. This endpoint returns the complete wrapper configuration, status, execution history, and monitoring data.

​
Authentication

This endpoint requires authentication. Include your API key in the request headers.

​
Path Parameters

​
wrapper_id
string
required
The unique identifier of the wrapper to retrieve

​
Response

​
wrapper_id
string
Unique identifier for the wrapper
​
resource_id
string
Associated resource ID (if created)
​
metadata
object
Indicator metadata describing the sustainability metric.
​
source_type
string
Type of data source: API, CSV, or XLSX
​
source_config
object
Source-specific configuration details (structure varies by source_type)
​
generated_code
string
Generated wrapper code (null if not yet generated)
​
created_at
string
ISO 8601 timestamp of creation
​
updated_at
string
ISO 8601 timestamp of last update
​
completed_at
string
ISO 8601 timestamp of completion (null if not completed)
​
status
string
Current status: pending, generating, creating_resource, executing, stopped, completed, or error
​
error_message
string
Error message if status is error
​
execution_log
array
Array of execution log messages
​
last_health_check
string
ISO 8601 timestamp of last health check
​
last_data_sent
string
ISO 8601 timestamp of last data transmission
​
data_points_count
integer
Number of data points processed
​
monitoring_details
object
Type-specific monitoring information (varies by wrapper type)
​
phase
string
Current execution phase: historical or continuous
​
high_water_mark
string
Newest data point timestamp ever sent (for resumable execution)
​
low_water_mark
string
Oldest data point timestamp ever sent (for resumable execution)
​
execution_result
object
Result of the last execution (if available).

​
Example Request

cURL
curl -X GET https://api.example.com/resources/wrappers/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "wrapper_id": "550e8400-e29b-41d4-a716-446655440000",
  "resource_id": "res_123456789",
  "metadata": {
    "name": "Average Temperature",
    "domain": "Environment",
    "subdomain": "Climate",
    "description": "Average daily temperature in degrees Celsius",
    "unit": "°C",
    "source": "National Climate Service",
    "scale": "National",
    "governance_indicator": false,
    "carrying_capacity": null,
    "periodicity": "Daily"
  },
  "source_type": "API",
  "source_config": {
    "location": "https://data-api.example.com/climate/temperature",
    "auth_type": "bearer",
    "timeout_seconds": 30,
    "date_field": "timestamp",
    "value_field": "temperature_celsius",
    "custom_headers": {},
    "query_params": {}
  },
  "generated_code": "import asyncio\nimport httpx\nfrom datetime import datetime\n\nasync def fetch_data():\n    ...",
  "created_at": "2026-03-03T10:30:00Z",
  "updated_at": "2026-03-03T10:35:00Z",
  "completed_at": null,
  "status": "executing",
  "error_message": null,
  "execution_log": [
    "Executed successfully at 2026-03-03T10:35:00Z",
    "Sent 127 data points"
  ],
  "last_health_check": "2026-03-03T10:40:00Z",
  "last_data_sent": "2026-03-03T10:39:45Z",
  "data_points_count": 127,
  "monitoring_details": {
    "process_id": 12345,
    "uptime_seconds": 600,
    "memory_mb": 45.2
  },
  "phase": "continuous",
  "high_water_mark": "2026-03-03T10:39:45Z",
  "low_water_mark": "2026-02-01T00:00:00Z",
  "execution_result": {
    "wrapper_id": "550e8400-e29b-41d4-a716-446655440000",
    "success": true,
    "message": "Wrapper executed successfully",
    "data_points_sent": 127,
    "execution_time": "2026-03-03T10:35:22Z"
  }
}

​
Error Responses

​
404 Not Found
Wrapper not found:
  • The wrapper_id does not exist
  • The wrapper was deleted
{
  "detail": "Wrapper not found"
}

​
Use Cases

  • Monitor the current status of a wrapper
  • Check execution history and logs
  • Retrieve generated code for inspection
  • View monitoring metrics and health data
  • Access checkpoint information (high/low water marks) for resumable wrappers

Build docs developers (and LLMs) love

Get started for freeTalk to us