{ "openapi": "3.0.1", "info": { "title": "SaaS Metrics & Cohort Retention Report (MRR, Churn, NRR)", "description": "Turn a subscription export (CSV, JSON or dataset) into monthly MRR bridge, churn, NRR, ARPA and cohort retention, plus a formatted Excel report. Pure calculation: no scraping, no logins.", "version": "0.1", "x-build-id": "KtRhOLemV9td7TjiE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cleancellco~saas-metrics-cohort-report/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cleancellco-saas-metrics-cohort-report", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/cleancellco~saas-metrics-cohort-report/runs": { "post": { "operationId": "runs-sync-cleancellco-saas-metrics-cohort-report", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/cleancellco~saas-metrics-cohort-report/run-sync": { "post": { "operationId": "run-sync-cleancellco-saas-metrics-cohort-report", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "subscriptions": { "title": "Subscriptions (JSON)", "type": "array", "description": "One object per subscription period: customer_id, start_date (YYYY-MM-DD), end_date (empty if active), and mrr OR amount + interval (week/month/quarter/year). The two SAMPLE rows are a demo: they are ignored automatically if you use CSV text, a CSV URL or a dataset, and you can also delete them." }, "csvText": { "title": "CSV text", "type": "string", "description": "Paste a CSV with the same columns (header row required)." }, "csvUrl": { "title": "CSV file URL", "type": "string", "description": "Direct public http(s) link to your own CSV export (max 50 MB). Private, local and internal network addresses are blocked." }, "datasetId": { "title": "Apify dataset ID", "type": "string", "description": "Read subscription rows from one of your existing datasets (read-only access is granted to the selected dataset only)." }, "fieldMapping": { "title": "Column names", "type": "object", "description": "Map your column names, e.g. {\"customer\":\"Customer ID\",\"start\":\"Created\",\"end\":\"Canceled At\",\"amount\":\"Amount\",\"interval\":\"Interval\"}. Amounts must be in currency units (e.g. 49.00), not cents." }, "asOfDate": { "title": "Report through date", "type": "string", "description": "YYYY-MM-DD. Defaults to today." }, "currency": { "title": "Currency label", "type": "string", "description": "Label only; no conversion.", "default": "USD" }, "reportTitle": { "title": "Report title", "type": "string", "description": "Title on the Summary sheet.", "default": "SaaS metrics" }, "excelReport": { "title": "Build Excel report", "type": "boolean", "description": "Save a formatted .xlsx to the key-value store as REPORT.", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }