1. Chart Analysis
Returning.AI
  • Getting Started
  • Users
    • User directory and provisioning
    • Get Users with Filters
      POST
    • Create New User
      POST
    • Get User Data
      POST
    • Manage User Account
      POST
    • Get User Milestones
      POST
    • Update User Data, Identifier, And Roles
      POST
    • Update User XP and Currency
      POST
  • Messaging
    • Agent messaging workflow
    • Get Messages
      GET
    • Send Message
      POST
    • Reply Message
      POST
    • React Message
      POST
    • Upload message images
      POST
  • Gamification
    • Leaderboards
      • Leaderboards
      • List leaderboards with pagination
      • Create a new leaderboard
      • Update an existing leaderboard
      • Get a single leaderboard by ID
      • Delete a leaderboard
    • Streaks & Mini Games
      • Mini-game State and History
      • List user streak logs
      • List mini-game logs by user email
      • Get current mini-game and streak state
      • Update user spin-wheel information
    • Referral
      • Referral Program Integration
      • Get referral programs
      • Get user's referral summary
    • Rolling Data
      • Get Daily Calculation Data
      • Get Rolling Calculation Data
    • Match Predictions
    • Get tier configuration
      GET
    • Get daily user XP and coin changes
      POST
    • Search user gamification logs
      POST
    • Get user activity stats
      POST
  • Rewards & Redemptions
    • Store catalog to redemptions
    • Update redemption order status or refund
    • List redemption orders by user email
    • List redemption statuses
    • Get redemption status by ID
    • List redemption orders by community
    • Create redemption order status
    • Get redemption order status history
  • Chart Analysis
    • Create Analysis
      POST
    • Get Analysis
      GET
    • Update Analysis
      PATCH
    • Delete Analysis
      DELETE
    • List Analyses
      GET
    • Append Drawings
      POST
  • Bulk Operations
    • Bulk user updates
    • List bulk update jobs
    • Get bulk update job status
    • Get bulk update job details
    • Bulk update users from CSV
    • Bulk update premium currency from CSV
  • Channels
    • Iframe
    • List integration channels
  • Events
    • Outgoing webhooks
      • Encryption
      • User Joins Server
      • User Visits server
      • New Message Posted Anywhere
      • New Message Posted To channel
      • Purchased Store Item
    • Incoming webhooks
      • API Keys & Encryption
      • Send message into channels
      • Update Custom User Fields
      • Update In-game currency
  • Widgets
    • Authenticated Widgets
    • Public widgets
    • Channels
    • Leaderboard
    • Milestone
    • Socials
    • Store
  • Community Analytics
    • Get Loyalty Overview
    • Get Phone Verification Contacts
  • Store
    • Store catalog
    • Purchase History
      • Update redemption instructions or voucher details
    • Categories
      • List Store categories
      • Create Store category
      • Get Store category by ID
      • Update Store category
      • Delete Store category
    • Products
      • List products
      • Update products in bulk
      • Create products in bulk
      • Create product with vouchers
      • Read product
      • Update product and append vouchers
      • Delete product
    • Redemption-transaction
      • Get redemption transaction detail
    • Get Store configuration
    • Update Store configuration
  • Community
    • Community directory and appearance
    • Appearance
      • Update community theme colors
      • Update community bot profile
      • Update community URL metadata
      • Update community name and URL
    • Community Users
      • Get community users
      • Get user
    • Create community
  • API Keys
    • API key lifecycle
    • Community API Keys
      • Create API key
      • Read API keys
      • Delete API key
      • Update API key
    • User API Keys
      • List user API keys
      • Create user API key
      • Update user API key
      • Delete user API key
      • Get current API key information
  • User Fields
    • User field definitions and history
    • User Field History
      • Get all user field histories in a community
      • Get user field histories for a specific field
      • Get user field histories for a specific user
      • Get user field histories of specific user field and user
      • Update A User Field Value
      • Deprecated Field-First History Write
      • Deprecated Field-First History Read
    • Get A User Field Definition
    • Update A User Field Definition
    • Create A User Field Definition
    • Delete A User Field Definition
    • List User Field Definitions
  • Legacy
    • Servers
      • Create server
      • List servers
      • Update server metadata
    • Bulk Operations
      • Bulk import users from CSV
    • Authentication
      • Secure Auth
      • Register user with password
      • Verify user email
      • Log in user with password
    • Badges
      • List badges
      • Create badge
      • Update badge
      • Delete badge
      • Remove badge from user
      • Award badge to user
    • Messaging
    • Roles & Permissions
      • List server roles
      • Create role
      • Update role
      • Delete role
      • List user roles
      • Add role to user
      • Remove role from user
    • Users
      • Get user
      • Upload user avatar
    • Channels
      • Create channel
      • Update channel
      • Delete channel
    • API Keys
      • List integration API keys
      • Create integration API key
      • Delete integration API key
      • Update integration API key
  1. Chart Analysis

Get Analysis

GET
/v1/analysis/{analysisId}

What this endpoint does#

Reads, updates, or deletes one analysis by id, depending on the HTTP method on this page (GET, PATCH, or DELETE).
Append drawings is a separate POST. Missing ids return 404 Analysis not found, not an empty analysis object.
INFO
Prove list first
Call List Analyses. Use an id from that list. Do not PATCH or DELETE a made-up ObjectId on a live channel.

Quick start#

PATCH and DELETE use the same path. PATCH needs sender for community API-key callers, same as create.

Authentication and permission#

Bearer community API key. Writes need sendMessage. Keep the key server-side.

Complete examples#

Missing analysis (404). GET, PATCH, and DELETE on an unknown ObjectId return { "status": "fail", "statusCode": 404, "message": "Analysis not found" }.
A populated GET/PATCH success body is not documented from a live chart-enabled fixture on this page.

Success and readback#

After PATCH, GET the same id. After DELETE, the id should 404 and disappear from the channel list.

Errors and recovery#

StatusWhenRecovery
404 Analysis not foundUnknown {analysisId}Copy an id from the list.
401Missing or invalid tokenReplace the key.

Retry safety#

WARNING
Exact retry
GET is safe to retry. PATCH/DELETE are mutations. Do not retry timeouts without GET or list first.

Gotchas#

{analysisId} is not a channel id or user id.
Create-body direction enums differ from list query enums.

Next steps#

List Analyses
Get a real id only from a channel list.

Request

Path Params

Responses

🟢200OK
application/json
Analysis retrieved successfully
Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-integration.returning.ai/apis/v1/analysis/69789f6d3e121add7de5e9c3'
Response Response Example
200 - Example 1
{
    "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"
    }
}
Modified at 2026-08-19 13:46:20
Previous
Create Analysis
Next
Update Analysis
Built with