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

# Summarize a schedule automation

> Counts the automation's runs of the last 30 days that ended as found, nothing or failed, and how many of them failed. Lists the trace id of each counted run that has a session, so the caller can price them. The answer has no cost. Counts the automation's topics once each, by what became of the last issue filed for the topic: open, fixed (a linked pull request merged) or closed without a fix. The numbers are computed when read. Answers 404 for an automation that is not a schedule automation.



## OpenAPI

````yaml /openapi.yaml get /v1/apps/{appId}/custom-automations/{automationId}/summary
openapi: 3.0.3
info:
  contact:
    email: hello@outerlayer.ai
    url: https://www.outerlayer.ai
  description: >-
    The OuterLayer Gateway API lets you ingest coding-agent sessions and record
    evidence of work programmatically.


    Most teams reach it through the `outerlayer` CLI, which calls it for them.

    Call it directly to build your own integration or to automate what the
    dashboard does.


    Versioning: every endpoint is prefixed with `/v1/`. Breaking changes ship
    under a new version prefix (`/v2/`, etc.) with a 90-day-minimum deprecation
    window; anything additive lands on the current prefix.


    Vocabulary: the dashboard calls this API's `app` a **factory** — the unit
    that owns a set of repositories, the agent sessions worked on them, and the
    evidence they produce. They are the same entity. The API keeps `app` in its
    paths, headers, and field names because those are a published contract; only
    the product surface was renamed.
  title: OuterLayer Gateway API
  version: '1.0'
servers:
  - description: Production (OuterLayer Cloud)
    url: https://api.outerlayer.ai
  - description: Local dev server (self-hosted gateway)
    url: http://localhost:9418
security:
  - AppId: []
    BearerAuth: []
tags:
  - description: >-
      What a CLI login token can read about its owner without naming a factory,
      such as the factories they can use.
    name: Account
  - description: >-
      The route a fleet machine asks for its next managed build on. A fleet
      machine is a machine OuterLayer operates.
    name: Fleet
  - description: >-
      The CLI version a gateway names to its runners, set with the gateway's
      runner version key.
    name: Runner version
  - description: >-
      Coding-agent session ingest (outerlayer sync) and content-addressed
      session images.
    name: Agents
  - description: >-
      Evidence artifacts (screenshots, recordings, reports, logs) emitted as
      proof of a change and anchored to pull requests.
    name: Artifacts
  - description: >-
      Pass/fail outcomes of checks run in your own CI or compute, anchored to
      pull requests with the run URL as proof.
    name: Emitted Results
  - description: >-
      The acceptance criteria of a work item, recorded as one list. The Criteria
      tab, its count and the item status read that list.
    name: Criteria
  - description: >-
      What any agent found wrong about a change under review or about a rule it
      ran on, recorded on a work item.
    name: Findings
  - description: >-
      Find, file and edit the issue a spec lives in, through OuterLayer, with no
      tracker credential on the caller's side.
    name: Specs
  - description: >-
      Add or remove a source's statement that it is working on an issue or pull
      request, and read what is currently live.
    name: Work Items
  - description: >-
      What the factory's GitHub App installation lets builds do on each
      connected repository, and whether each default branch requires a pull
      request.
    name: Repositories
  - description: >-
      The runs of a schedule automation: a runner claims a run, asks for its
      read token and ends it, and the run's agent reports each issue it found or
      that it found nothing.
    name: Schedule runs
  - description: >-
      A runner host's heartbeat — its CLI version, slots and last request for
      work — and the factory's list of hosts with a derived status.
    name: Hosts
  - description: Query server feature availability.
    name: Capabilities
  - description: Per-model LLM pricing data. Public, unauthenticated.
    name: Pricing
  - description: >-
      Create, list, and revoke factory API keys. Plaintext returned exactly once
      at creation.
    name: API Keys
  - description: >-
      Factory CRUD — a factory is owned by an organization and is the unit every
      other resource hangs off. Lets a headless agent provision one without the
      dashboard.
    name: Apps
  - description: >-
      Agent-coding session list and full transcript reads, with actor-privacy
      controls for machine keys.
    name: Sessions
  - description: >-
      Per-model token spend and fleet-wide agent behavior tiles, including
      two-window comparisons.
    name: Metrics
  - description: Synced-commit history of the app's `.outerlayer/` context tree.
    name: Context
  - description: >-
      Session→PR attribution: which agent sessions produced which pull requests,
      and what each attributed PR cost.
    name: PRs
  - description: Service health checks.
    name: Health
  - description: >-
      Org member and role administration, authenticated with an org-scoped
      management API key (`olk_…`) minted in the dashboard's settings.
    name: Org Management
  - description: OAuth 2.1 discovery metadata for MCP connector clients.
    name: OAuth
paths:
  /v1/apps/{appId}/custom-automations/{automationId}/summary:
    get:
      tags:
        - Apps
      summary: Summarize a schedule automation
      description: >-
        Counts the automation's runs of the last 30 days that ended as found,
        nothing or failed, and how many of them failed. Lists the trace id of
        each counted run that has a session, so the caller can price them. The
        answer has no cost. Counts the automation's topics once each, by what
        became of the last issue filed for the topic: open, fixed (a linked pull
        request merged) or closed without a fix. The numbers are computed when
        read. Answers 404 for an automation that is not a schedule automation.
      operationId: get-schedule-automation-summary
      parameters:
        - in: path
          name: appId
          required: true
          schema:
            format: uuid
            type: string
        - in: path
          name: automationId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      periodDays:
                        description: >-
                          The length of the period the run counts cover, counted
                          back from the time of the read.
                        enum:
                          - 30
                        type: number
                      runs:
                        properties:
                          failed:
                            description: The counted runs whose state is `failed`.
                            type: integer
                          total:
                            description: >-
                              The runs created in the period whose state is
                              `found`, `nothing` or `failed`.
                            type: integer
                          traceIds:
                            description: >-
                              The trace id of the session of each counted run
                              that has one. The list has no cap. Cost is not
                              part of this answer: read it from the analytics
                              store.
                            items:
                              type: string
                            type: array
                        required:
                          - total
                          - failed
                          - traceIds
                        type: object
                      topics:
                        properties:
                          closedNoFix:
                            description: >-
                              Topics whose last issue is closed with no merged
                              pull request, or left the Work page. A topic a
                              member chose to file again counts here until
                              OuterLayer files the next issue.
                            type: integer
                          fixed:
                            description: >-
                              Topics whose last issue is closed after a linked
                              pull request merged.
                            type: integer
                          open:
                            description: >-
                              Topics whose last issue is open and on the Work
                              page.
                            type: integer
                        required:
                          - open
                          - fixed
                          - closedNoFix
                        type: object
                    required:
                      - periodDays
                      - runs
                      - topics
                    type: object
                required:
                  - data
                type: object
          description: The summary.
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Invalid request parameters (validation failed).
        '401':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Missing or invalid API key.
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Caller lacks 'factory.read' permission.
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: The factory holds no schedule automation with this id (`not_found`).
components:
  securitySchemes:
    AppId:
      description: Factory id the request is scoped to.
      in: header
      name: X-Outerlayer-App-Id
      type: apiKey
    BearerAuth:
      description: API key (sk_outerlayer_*)
      scheme: bearer
      type: http

````

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