AsoBeast Jobs API

openapi: 3.2.0
info:
  title: Asobeast Com Jobs API
  x-refined-note:
  - x-authored-by differs across the merged source definitions and was not carried
  - x-engine differs across the merged source definitions and was not carried
  - x-evidence-tiers differs across the merged source definitions and was not carried
  - x-generated differs across the merged source definitions and was not carried
  - x-generated-from differs across the merged source definitions and was not carried
  - x-generator differs across the merged source definitions and was not carried
  - x-provenance differs across the merged source definitions and was not carried
  - x-sources differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Jobs across 2 of this provider''s published API definitions: asobeast-com-openapi-generated.yml, asobeast-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: http://localhost:3000/api/backend
  description: Web origin proxy
- url: http://localhost:4000
  description: Direct API
tags:
- name: Jobs
paths:
  /jobs/budget:
    get:
      operationId: get_jobs_budget
      tags:
      - Jobs
      summary: GET /jobs/budget returns the estimated daily fan out broken down by kind…
      description: Provides the estimated daily fan‑out and capacity information.
      x-source: https://docs.asobeast.com/api-reference/conventions.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
      security:
      - bearer: []
  /apps/{id}/run-daily:
    post:
      operationId: JobsController_runDaily
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '202':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Manually run the daily pipeline for one app
      tags:
      - Jobs
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /apps/{id}/first-run:
    get:
      operationId: JobsController_firstRun
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Report what a newly imported app is still waiting for
      tags:
      - Jobs
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /apps/{id}/run-status:
    get:
      description: Counts, for one app, the listings captured for the app and its competitors in the home storefront and every tracked market, the active keywords whose position was checked and the category charts read against the charts the app is ranked in (the chart of its price class and the grossing chart, each in its category and overall), since the daily trigger or since midnight UTC once the trigger has passed. state is running while counts are missing, complete when every count is in and delayed twenty hours after the trigger with counts still missing. paused is true when the workspace is suspended or has no plan in force, which the daily run skips, so counts will not advance; state is not changed by it. Reads stored rows only and never touches the queue. Answers 404 for an unknown app.
      operationId: JobsController_runStatus
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Today's run of one app
      tags:
      - Jobs
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /jobs/run-status:
    get:
      operationId: BudgetController_status
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Progress of this workspace's own daily run
      tags:
      - Jobs
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
  /jobs/store-health:
    get:
      operationId: BudgetController_storeHealth
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      summary: Report whether each store still parses
      tags:
      - Jobs
      security:
      - personalApiToken: []
    servers:
    - url: http://localhost:3000/api/backend
      description: Web origin proxy
    - url: http://localhost:4000
      description: Direct API
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
    personalApiToken:
      scheme: bearer
      bearerFormat: asob
      type: http
x-refined-from:
- asobeast-com-openapi-generated.yml
- asobeast-com-openapi.json