Recoup

Get started with Recoup.

API REFERENCE

Catalog Stream Tracking

On this page
GET/api/catalogs/{catalogId}/stream-tracking

Read enabled state and latest run coverage without starting provider work. Standard MCP manage_catalog_stream_tracking with action=status. Unchanged daily values reuse their saved versions; new dates and corrections are appended, with fresh coverage/provenance receipts for every run.

Authentication

x-api-key in header

bearerAuth bearer

Request

cURL
curl --request GET \
  --url 'https://api.recoupable.dev/api/catalogs/YOUR_CATALOG_ID/stream-tracking' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Try it

Fill in the fields, send the request from your browser, and read the live response. The curl below updates as you type.

Kept in this browser tab only and cleared when it closes.

cURL for this request
curl --request GET \
  --url 'https://recoup-api.vercel.app/api/catalogs/{catalogId}/stream-tracking'

Parameters

Path parameters

catalogIdstringrequired

Catalog owned by the authenticated account or an organization it currently belongs to.

Responses

200Collection status

application/json

statusstring
catalog_idstring

format: uuid

providerstring · enum

Values: "luminate"

platformstring · enum

Values: "all_dsps"

metricstring · enum

Values: "daily_streams"

latest_runobject | null

Run status, per-ISRC coverage, errors, window and completion timestamp.

Properties for latest_run
idstring

format: uuid

catalog_idstring

format: uuid

revisionstring

format: uuid

scheduled_daystring

format: date

sincestring

format: date

untilstring

format: date

statusstring · enum

Values: "queued", "running", "complete", "partial", "failed", "cancelled"

coverageobject
errorstring | null
created_atstring

format: date-time

finished_atstring | null

format: date-time

territorystring · enum

Values: "worldwide"

trackingobject | null
Properties for tracking
catalog_idstring

format: uuid

owner_idstring

format: uuid

enabledboolean
revisionstring

format: uuid

updated_atstring

format: date-time

collectionobject | null
Properties for collection
statestring · enum

Values: "started", "already_claimed_or_disabled"

run_idstring | null

format: uuid

workflow_run_idstring
400Invalid input

No response body schema is specified.

401Authentication required

No response body schema is specified.

404Catalog not accessible

No response body schema is specified.

503Storage, configuration or dispatch unavailable

No response body schema is specified.

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download releases.json
View operation source
json
{
  "summary": "Inspect daily catalog tracking",
  "description": "Read enabled state and latest run coverage without starting provider work. Standard MCP manage_catalog_stream_tracking with action=status. Unchanged daily values reuse their saved versions; new dates and corrections are appended, with fresh coverage/provenance receipts for every run.",
  "security": [
    {
      "apiKeyAuth": []
    },
    {
      "bearerAuth": []
    }
  ],
  "parameters": [
    {
      "name": "catalogId",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      },
      "description": "Catalog owned by the authenticated account or an organization it currently belongs to."
    }
  ],
  "responses": {
    "200": {
      "description": "Collection status",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "status": {
                "type": "string"
              },
              "catalog_id": {
                "type": "string",
                "format": "uuid"
              },
              "provider": {
                "type": "string",
                "enum": [
                  "luminate"
                ]
              },
              "platform": {
                "type": "string",
                "enum": [
                  "all_dsps"
                ]
              },
              "metric": {
                "type": "string",
                "enum": [
                  "daily_streams"
                ]
              },
              "latest_run": {
                "$ref": "#/components/schemas/CatalogStreamRun",
                "description": "Run status, per-ISRC coverage, errors, window and completion timestamp."
              },
              "territory": {
                "type": "string",
                "enum": [
                  "worldwide"
                ]
              },
              "tracking": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "catalog_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "owner_id": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "enabled": {
                    "type": "boolean"
                  },
                  "revision": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "updated_at": {
                    "type": "string",
                    "format": "date-time"
                  }
                }
              },
              "collection": {
                "type": [
                  "object",
                  "null"
                ],
                "properties": {
                  "state": {
                    "type": "string",
                    "enum": [
                      "started",
                      "already_claimed_or_disabled"
                    ]
                  },
                  "run_id": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "uuid"
                  },
                  "workflow_run_id": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid input"
    },
    "401": {
      "description": "Authentication required"
    },
    "404": {
      "description": "Catalog not accessible"
    },
    "503": {
      "description": "Storage, configuration or dispatch unavailable"
    }
  }
}