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

List Analyses

GET
/v1/analysis/communities/{communityId}/channels/{channelId}

What this endpoint does#

Lists chart analyses for one community ObjectId and channel ObjectId.
It does not create an analysis. Public channel list does not include chartsEnabled; a channel can list analyses as empty and still reject create.
INFO
Workflow
GET /v1/channels for _id → GET /v1/analysis/communities/{communityId}/channels/{channelId} → if you need to post, the channel must have chartsEnabled: true outside this list.

Quick start#

Authentication and permission#

Bearer community API key. Chart writes use sendMessage; this list is a GET. Keep the key server-side.

Complete examples#

Empty list (200). message is Analyses fetched successfully. Envelope { status: "success", statusCode: 200, message, data: { analyses, pagination } }.
Pagination fields: page, limit, total, totalPages, hasNextPage, hasPrevPage. Empty analyses is success.
Lowercase direction (200). ?direction=bullish is valid.
Uppercase direction (400). ?direction=BULLISH returns List Analyses Request Validation validation error. detail.direction: Invalid enum value. Expected 'bullish' | 'bearish' | 'all', received 'BULLISH'.
status query expects Pending | Active | Expired | Cancelled | all. status=Hit is rejected.

Success and readback#

HTTP 200. Repeat after create/delete. This GET is the list readback.

Errors and recovery#

StatusWhenRecovery
400 direction enumBULLISH or other casingSend bullish, bearish, or all.
401Missing or invalid tokenAdd a valid community key.

Retry safety#

TIP
Exact retry
This GET does not create analyses. Retry timeouts with bounded backoff.

Gotchas#

Direction filters are lowercase. Create-body metadata.direction is BULLISH or BEARISH (different enum).
Empty list does not prove the channel accepts creates.

Next steps#

Create Analysis
Requires sender, metadata, levels, and a chart-enabled channel.

Request

Path Params

Query Params

Responses

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

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://adss-integration.returning.ai/apis/v1/analysis/communities/6502c9e514a3e564c5c09c0a/channels/656966caae59563fb291b324?limit=20&page=1&status=Pending&timeframe=H1&direction=BULLISH'
Response Response Example
200 - Success Example
{
    "status": "success",
    "message": "Analyses retrieved successfully",
    "data": {
        "analyses": [
            {
                "analysisId": "507f1f77bcf86cd799439022",
                "title": "EURUSD Bullish Bounce",
                "symbol": "EURUSD",
                "direction": "BULLISH",
                "status": "Pending",
                "createdAt": "2025-01-09T12:00:00Z",
                "updatedAt": "2025-01-09T12:00:00Z"
            }
        ],
        "pagination": {
            "total": 45,
            "limit": 10,
            "offset": 0,
            "hasMore": true
        }
    }
}
Modified at 2026-08-19 13:46:05
Previous
Delete Analysis
Next
Append Drawings
Built with