Skip to content
Navigation

Get presentation

GET
https://api.sureshake.com/v2/reports/{id}/presentation

Path parameters

  • id
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    object
    required
    • strategy
      brokerage_statement
      or
      financial_statements
      or
      generic_report
      required
    • header
      object
      required
      • eyebrow
        string
        or null
        required
      • title
        string
        required
      • periodLabel
        string
        or null
        required
      • sourceLabel
        string
        or null
        required
      • status
        object
        required
        • label
          string
          required
        • tone
          accent
          or
          neutral
          required
    • figures
      array of
      object
      required
      • key
        string
        required
      • label
        string
        required
      • value
        string
        required
      • note
        string
        or null
        required
      • tone
        neutral
        or
        positive
        or
        negative
        required
      • source
        string
        required
    • notInReport
      object
      or null
      required
      • items
        array of
        string
        required
      • note
        string
        required
    • sections
      array of
      required

      Any of the following:

      • object
        • kind
          allocation
          required
        • key
          string
          required
        • title
          string
          required
        • description
          string
          or null
          required
        • segments
          array of
          object
          required
          • label
            string
            required
          • value
            number
            required
          • percent
            number
            or null
            required
          • display
            string
            required
        • footnote
          string
          or null
          required
      • object
        • kind
          table
          required
        • key
          string
          required
        • title
          string
          required
        • description
          string
          or null
          required
        • columns
          array of
          object
          required
          • key
            string
            required
          • label
            string
            required
          • align
            start
            or
            end
            required
        • rows
          array of
          object
          required
          • key
            string
            required
          • cells
            array of
            object
            required
            • text
              string
              required
            • detail
              optional
              string
              or null
            • tone
              optional
              neutral
              or
              positive
              or
              negative
          • emphasis
            optional
            boolean
        • footnote
          string
          or null
          required
      • object
        • kind
          statements
          required
        • key
          string
          required
        • title
          string
          required
        • description
          string
          or null
          required
        • unitLabel
          string
          required
        • statements
          array of
          object
          required
          • key
            string
            required
          • label
            string
            required
          • columns
            array of
            string
            required
          • rows
            array of
            object
            required
            • label
              string
              required
            • values
              array of
              string
              required
            • emphasis
              optional
              boolean
          • footnote
            string
            or null
            required
      • object
        • kind
          readings
          required
        • key
          string
          required
        • title
          string
          required
        • description
          string
          or null
          required
        • items
          array of
          object
          required
          • text
            string
            required
          • sources
            array of
            string
            required
      • object
        • kind
          markdown
          required
        • key
          string
          required
        • title
          string
          required
        • description
          string
          or null
          required
        • body
          string
          required
    • details
      array of
      object
      required
      • label
        string
        required
      • value
        string
        required
    • verification
      object
      required
      • rows
        array of
        object
        required
        • label
          string
          required
        • value
          string
          required
        • technical
          optional
          boolean
      • note
        string
        required
    • sources
      array of
      object
      required
      • key
        string
        required
      • title
        string
        required
      • description
        string
        required
      • format
        json
        or
        ixbrl
        or
        pdf
        required
      • dataKey
        string
        or null
        required
      • available
        boolean
        required
      • unavailableReason
        string
        or null
        required
    • chat
      object
      required
      • subject
        string
        required
      • suggestedQuestions
        array of
        string
        required

400

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

401

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

403

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

404

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

500

Default Response
JSON
  • error
    object
    required
    • code
      string
      required

      Machine-readable error code (e.g., NOT_FOUND)

    • message
      string
      required

      Human-readable error message

    • details
      optional
      unknown

      Optional structured error details

    • traceId
      optional
      string

      Unique ID for log correlation

Type to search…

↑↓ navigate↵ selectEsc close