Get Analysis

What it is for: Get Analysis. Use this for chart-analysis content, metadata, drawings, and lifecycle management.
How to use it: Send a GET request to /v1/analysis/{analysisId} with the request body, query parameters, or multipart fields shown below. Authorization: Bearer <apiKey>. The key must be active, unexpired, scoped to the correct community, and include the permission required by this endpoint.
Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under data with status and message.
Common error states:

400 invalid request body, query, ObjectId, pagination, file format, or missing required field.

401 missing, invalid, expired, or insufficient API key/token.

403 key is valid but cannot access this community/channel/user/resource, where supported by the service.

404 target resource, route, or community-scoped record was not found.

409 duplicate or conflicting state for create/update operations, where applicable.

500 unexpected Returning.AI service error.

{ "status": "success", "message": "Analysis retrieved successfully", "data": { "analysisId": "507f1f77bcf86cd799439022", "metadata": { "direction": "BULLISH", "entryPlacement": "ABOVE_CURRENT", "expiry": { "type": "GTC" }, "title": "EURUSD Bullish Bounce from Support", "preferenceText": "Price bounced from [[support_zone:demand zone]]", "alternativeText": "string", "comments": "string", "timeframe": "M1", "symbol": "EURUSD" }, "levels": { "pivot": { "price": 1.09, "clientObjectId": "pivot_main", "time": "2025-01-09T12:00:00Z" }, "resistance": { "price": 1.09, "clientObjectId": "pivot_main", "time": "2025-01-09T12:00:00Z" }, "support": { "price": 1.09, "clientObjectId": "pivot_main", "time": "2025-01-09T12:00:00Z" }, "intermediateResistance": { "price": 1.09, "clientObjectId": "pivot_main", "time": "2025-01-09T12:00:00Z" }, "intermediateSupport": { "price": 1.09, "clientObjectId": "pivot_main", "time": "2025-01-09T12:00:00Z" } }, "drawings": [ { "type": "HORIZONTAL_LINE", "clientObjectId": "string", "points": [ { "time": "2025-01-09T12:00:00Z", "price": 1.09 } ], "style": { "color": "#FF0000", "lineWidth": 2, "lineStyle": "SOLID", "fillColor": "#00FF0033", "borderColor": "#00FF00", "opacity": 1 } } ], "status": "Pending", "createdBy": { "userId": "string", "username": "string", "displayName": "string" }, "createdAt": "2019-08-24T14:15:22.123Z", "updatedAt": "2019-08-24T14:15:22.123Z" } }

Request

Responses