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

# List a program’s logs

> The program’s logs, most recently written first: each log’s pinned release, stage and head, when it was opened and last written, and the roles it waits on. Filter by release or stage. A log the caller cannot read is left out, so a page can hold fewer than `limit` and still have a `nextCursor`. For the next page, send `nextCursor` as `cursor` with the same filters and `limit`. Read one log at `/{log}`.



## OpenAPI

````yaml /openapi.json get /rsl/{id}/logs
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.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /rsl/{id}/logs:
    get:
      tags:
        - Your programs
      summary: List a program’s logs
      description: >-
        The program’s logs, most recently written first: each log’s pinned
        release, stage and head, when it was opened and last written, and the
        roles it waits on. Filter by release or stage. A log the caller cannot
        read is left out, so a page can hold fewer than `limit` and still have a
        `nextCursor`. For the next page, send `nextCursor` as `cursor` with the
        same filters and `limit`. Read one log at `/{log}`.
      operationId: listProgramLogs
      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: integer
            minimum: 0
            exclusiveMinimum: true
            description: Only logs pinned to this release.
          required: false
          description: Only logs pinned to this release.
          name: release
          in: query
        - schema:
            type: string
            enum:
              - Open
              - Ineligible
              - Declined
              - Quotable
              - Bound
              - Closed
            description: Only logs at this stage at their head.
          required: false
          description: Only logs at this stage at their head.
          name: stage
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
            description: Most logs to return, 1–200. Defaults to 50.
          required: false
          description: Most logs to return, 1–200. Defaults to 50.
          name: limit
          in: query
        - schema:
            type: string
            minLength: 1
            maxLength: 8192
            description: >-
              Opaque nextCursor from this operation. Repeat every other query
              parameter unchanged; a cursor from a different query returns
              invalid_cursor.
          required: false
          description: >-
            Opaque nextCursor from this operation. Repeat every other query
            parameter unchanged; a cursor from a different query returns
            invalid_cursor.
          name: cursor
          in: query
      responses:
        '200':
          description: One page of the program’s logs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  logs:
                    type: array
                    items:
                      $ref: '#/components/schemas/LogListItem'
                  nextCursor:
                    type: string
                    nullable: true
                    description: Cursor for the next page, or null on the last page.
                required:
                  - logs
                  - nextCursor
                additionalProperties: false
        '400':
          description: Invalid 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 program is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    LogListItem:
      allOf:
        - $ref: '#/components/schemas/Log'
        - type: object
          properties:
            waitingOn:
              type: array
              items:
                type: string
              description: >-
                The roles with an open question at the head, such as uw or
                manager.
          required:
            - waitingOn
    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
    Log:
      type: object
      properties:
        submission:
          type: string
        guideline:
          type: string
        releaseVersion:
          type: integer
          description: The release the log is pinned to.
        bundleId:
          type: string
          description: The release’s bundle, which the log stays on.
        programId:
          type: string
          description: The program the log is pinned to.
        head:
          type: integer
          description: The last entry’s seq.
        stage:
          type: string
          enum:
            - Open
            - Ineligible
            - Declined
            - Quotable
            - Bound
            - Closed
          description: The stage at the head.
        openedAt:
          type: string
        updatedAt:
          type: string
      required:
        - submission
        - guideline
        - releaseVersion
        - bundleId
        - programId
        - head
        - stage
        - openedAt
        - updatedAt
    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.