> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the status of a log

> What the log’s program says about the answers as of an entry (the head by default), in a quote option’s view if one is named: the stage, the outcomes, what declines, the open questions and who answers each, the referrals and the quotes. The status at an entry never changes.



## OpenAPI

````yaml /openapi.json get /rsl/{id}/logs/{log}/status
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /rsl/{id}/logs/{log}/status:
    get:
      tags:
        - Your programs
      summary: Get the status of a log
      description: >-
        What the log’s program says about the answers as of an entry (the head
        by default), in a quote option’s view if one is named: the stage, the
        outcomes, what declines, the open questions and who answers each, the
        referrals and the quotes. The status at an entry never changes.
      operationId: getProgramLogStatus
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: >-
              Your organization’s ID for the program, chosen at its first
              upload: lowercase letters, digits, dots, underscores and hyphens.
              A rater’s program ID is its rater ID.
          required: true
          description: >-
            Your organization’s ID for the program, chosen at its first upload:
            lowercase letters, digits, dots, underscores and hyphens. A rater’s
            program ID is its rater ID.
          name: id
          in: path
        - schema:
            type: string
            format: uuid
            description: >-
              The log’s id: a UUID the caller chooses when it opens the log,
              such as the id of the case the log decides. One id has one log.
          required: true
          description: >-
            The log’s id: a UUID the caller chooses when it opens the log, such
            as the id of the case the log decides. One id has one log.
          name: log
          in: path
        - schema:
            type: integer
            nullable: true
            minimum: 0
            description: The entry (seq) to read as of. Defaults to the head.
          required: false
          description: The entry (seq) to read as of. Defaults to the head.
          name: at
          in: query
        - schema:
            type: string
            pattern: ^[A-Za-z_][A-Za-z0-9_]{0,63}$/u
            description: >-
              A quote option, whose answers are read over the shared ones. Omit
              for the shared answers.
          required: false
          description: >-
            A quote option, whose answers are read over the shared ones. Omit
            for the shared answers.
          name: option
          in: query
      responses:
        '200':
          description: The status and the entry it is as of.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogStatusAt'
        '400':
          description: Invalid log, query or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            The caller cannot read the program, as the program’s own call routes
            refuse it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: The log is not opened on this program, or the caller cannot read it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    LogStatusAt:
      type: object
      properties:
        seq:
          type: integer
          description: The entry read as of.
        status:
          $ref: '#/components/schemas/LogStatus'
      required:
        - seq
        - status
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: Not currently returned.
          required:
            - code
    LogStatus:
      type: object
      properties:
        stage:
          type: string
          enum:
            - Open
            - Ineligible
            - Declined
            - Quotable
            - Bound
            - Closed
          description: Where the submission stands.
        outcomes:
          type: object
          additionalProperties:
            nullable: true
          description: The rating outcomes; empty while any is unknown.
        unrated:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: The outcome’s or referral’s name.
              by:
                type: string
                description: The alias of the used program that declines.
              code:
                type: string
                description: The declining rule’s code.
              message:
                type: string
            required:
              - name
              - by
              - code
              - message
          description: >-
            Outcomes and referral conditions with no value because a program
            they read declines.
        declines:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: The rule’s code, or the referral’s name.
              message:
                type: string
              path:
                type: string
              cite:
                nullable: true
                description: A JSON value, as the program reads it. Numbers as written.
            required:
              - code
              - message
              - path
          description: Rules and sign-offs that decline.
        open:
          type: array
          items:
            type: object
            properties:
              question:
                type: string
                description: An input’s path, or a referral’s name.
              kind:
                type: string
                enum:
                  - input
                  - signoff
              role:
                type: string
                nullable: true
                description: The lowest role that may answer it.
              choices:
                nullable: true
                description: A JSON value, as the program reads it. Numbers as written.
              because:
                type: string
              reads:
                type: array
                items:
                  type: object
                  properties:
                    path:
                      type: string
                    value:
                      nullable: true
                      description: >-
                        A JSON value, as the program reads it. Numbers as
                        written.
                  required:
                    - path
            required:
              - question
              - kind
              - role
          description: The questions still open.
        referrals:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: >-
                  The referral’s name. A referral on the items of a keyed list
                  is one per item, named by the item’s address.
              state:
                type: string
                enum:
                  - Unknown
                  - NotReferred
                  - Open
                  - Approved
                  - Declined
              role:
                type: string
                description: The lowest role that may sign it off.
              because:
                type: string
              lapsed:
                type: boolean
                description: >-
                  A sign-off was given and no longer counts: a value it reads
                  changed.
              reads:
                type: array
                items:
                  type: object
                  properties:
                    path:
                      type: string
                    value:
                      nullable: true
                      description: >-
                        A JSON value, as the program reads it. Numbers as
                        written.
                  required:
                    - path
            required:
              - name
              - state
              - role
              - because
              - lapsed
              - reads
        invalid:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: The rule’s code, or the referral’s name.
              message:
                type: string
              path:
                type: string
              cite:
                nullable: true
                description: A JSON value, as the program reads it. Numbers as written.
            required:
              - code
              - message
              - path
          description: Answers the contract refuses.
        quotes:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              outcomes:
                type: object
                additionalProperties:
                  nullable: true
                description: >-
                  Each rating outcome by name, numbers as the program computed
                  them. An outcome on the items of a keyed list is an object by
                  item key.
              stands:
                type: boolean
                description: The present answers are the ones quoted.
              bound:
                type: boolean
              lapsed_by:
                type: array
                items:
                  type: string
                description: What changed since the quote.
            required:
              - name
              - outcomes
              - stands
              - bound
      required:
        - stage
        - outcomes
        - declines
        - open
        - referrals
        - invalid
        - quotes
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.