Create Analysis
POST
/v1/analysis/{communityId}/channels/{channelId}
Analysis Types
bullish_breakout: BULLISH + ABOVE_CURRENTbullish_bounce: BULLISH + BELOW_CURRENTbearish_bounce: BEARISH + ABOVE_CURRENTbearish_breakout: BEARISH + BELOW_CURRENTWebhook Events
create_analysis webhook event with full analysis payload.Bot Notifications
bot:notification with otpId, serverId, userId, channelId.How to use it: Send a POST request to
/v1/analysis/{communityId}/channels/{channelId} 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.Request
Path Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/v1/analysis/6502c9e514a3e564c5c09c0a/channels/656966caae59563fb291b324' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"sender": "pangray2025+t5@gmail.com",
"metadata": {
"direction": "BULLISH",
"entryPlacement": "BELOW_CURRENT",
"expiry": {
"type": "HOURS",
"hours": 24
},
"title": "GBPUSD Bullish Bounce from Support",
"preferenceText": "Price bounced from [[support_zone:demand zone]]. Entry above [[entry_line:breakout level]] with target at [[target:resistance]].",
"alternativeText": "If price breaks below support, analysis invalidated",
"comments": "Watch for volume confirmation",
"timeframe": "H1",
"symbol": "GBP/USD"
},
"levels": {
"pivot": {
"price": 1.345,
"clientObjectId": "pivot_main",
"time": "2026-01-08T12:00:00Z"
},
"resistance": {
"price": 1.35,
"clientObjectId": "res_1",
"time": "2026-01-08T14:00:00Z"
},
"support": {
"price": 1.341,
"clientObjectId": "sup_1",
"time": "2026-01-08T10:00:00Z"
}
},
"drawings": [
{
"type": "RECTANGLE",
"clientObjectId": "support_zone",
"points": [
{
"time": "2026-01-08T00:00:00Z",
"price": 1.338
},
{
"time": "2026-01-09T00:00:00Z",
"price": 1.347
}
],
"style": {
"fillColor": "#00FF33",
"borderColor": "#00FF00",
"lineWidth": 2
}
},
{
"type": "LINE",
"clientObjectId": "entry_line",
"points": [
{
"time": "2026-01-08T00:00:00Z",
"price": 1.3485
},
{
"time": "2026-01-09T00:00:00Z",
"price": 1.3505
}
],
"startHead": "NONE",
"endHead": "ARROW",
"style": {
"color": "#0000FF",
"lineWidth": 2,
"lineStyle": "DASHED"
}
},
{
"type": "HORIZONTAL_LINE",
"clientObjectId": "target",
"points": [
{
"time": "2026-01-08T10:00:00Z",
"price": 1.355
}
],
"style": {
"color": "#FF0000",
"lineWidth": 2,
"lineStyle": "SOLID"
}
}
],
"idempotencyKey": "analysis_20250109_001"
}'Response Response Example
200 - Success Example
{
"status": "success",
"message": "Analysis created successfully",
"data": {
"analysisId": "507f1f77bcf86cd799439022",
"objectIdMap": {
"pivot_main": "60d5ec49f1b2c8b1f8e4c8a1:8",
"res_1": "60d5ec49f1b2c8b1f8e4c8a1:7",
"sup_1": "60d5ec49f1b2c8b1f8e4c8a1:0",
"res_int": "60d5ec49f1b2c8b1f8e4c8a1:5",
"sup_int": "60d5ec49f1b2c8b1f8e4c8a1:2",
"support_zone": "60d5ec49f1b2c8b1f8e4c8a2",
"entry_line": "60d5ec49f1b2c8b1f8e4c8a3",
"target": "60d5ec49f1b2c8b1f8e4c8a4"
}
}
}Modified at 2026-05-18 17:03:37