Skip to content
Navigation

Get publication composition

GET
https://api.sureshake.com/v2/reports/{id}/publication-composition

Path parameters

  • id
    string
    required
    format: uuid

Returns

200

Default Response

JSON
  • data
    object
    required
    • schema
      sureshake.publication-composition.v1
      required
    • publicationId
      string
      required
      format: uuid
    • kind
      update
      or
      document
      required
    • content
      document
      or
      update
      required
    • sections
      array of
      publication
      or
      access
      or
      activity
      required
    • permissions
      object
      required
      • manageAccess
        boolean
        required
      • viewActivity
        boolean
        required
    • insights
      object
      required
      • status
        unsupported
        required
      • reason
        no_publication_analysis_pipeline
        required
    • assistant
      object
      required
      • status
        unavailable
        required
      • reason
        publication_content_not_connected
        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