{ "openapi": "3.0.1", "info": { "title": "pub.dev Package Rankings & Score Change Monitor", "description": "Export and monitor pub.dev package rankings for Dart and Flutter. Track downloads, likes and pub points with top-N snapshots and saved change history.", "version": "0.1", "x-build-id": "N9jfAQ5qjtUO605et" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~pub-dev-package-rankings-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-pub-dev-package-rankings-monitor", "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/automa-flow~pub-dev-package-rankings-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-pub-dev-package-rankings-monitor", "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/automa-flow~pub-dev-package-rankings-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-pub-dev-package-rankings-monitor", "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": { "mode": { "title": "Mode", "enum": [ "snapshot", "monitor" ], "type": "string", "description": "Get current rankings returns every selected package and writes no history. Monitor changes compares this successful run with the last successful run of the same query in the same state namespace. Ranking lists are cached for eight hours; scores are fetched on each check. Prefer daily or weekly monitors.", "default": "snapshot" }, "outputMode": { "title": "Package output", "enum": [ "all", "changesOnly" ], "type": "string", "description": "All packages returns every current row. Changes only omits UNCHANGED rows. Snapshot plus changesOnly is rejected before any pub.dev request.", "default": "all" }, "stateNamespace": { "title": "State namespace", "minLength": 1, "maxLength": 64, "type": "string", "description": "Isolates monitor history. Use a stable name per watch, for example top20. Letters, numbers, '_' and '-', 1-64 characters. Snapshot mode ignores it.", "default": "default" }, "topN": { "title": "Top N", "minimum": 1, "maximum": 200, "type": "integer", "description": "How many ranked packages to keep when watchlist is empty. 1-200, default 20. Prefix of official completion-data order. Ignored for filtering when watchlist is set; rank still comes from the full list. At FREE/BRONZE prices, snapshot top-200 needs a budget of at least $0.20005 including start.", "default": 20 }, "watchlist": { "title": "Package watchlist", "minItems": 0, "maxItems": 50, "type": "array", "description": "Optional Dart package names or https://pub.dev/packages/{name} URLs, 0-50. Empty means use topN. A name missing from completion-data is unranked, not NOT_FOUND. A non-HTML HTTP 404 on the score endpoint is item-level NOT_FOUND. Duplicates keep the first name. A 50-package snapshot needs a FREE/BRONZE budget of at least $0.05005 including start.", "items": { "type": "string" } }, "includePackageMetadata": { "title": "Include package metadata", "type": "boolean", "description": "If true, fetch each selected package's /api/packages/{name} for description, homepage and latest version. Default off. Never dumps all 20 000 names. Never collects publisher emails.", "default": false }, "maxPackageRows": { "title": "Max package rows", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Cap on delivered package_observation rows. Default 2000 so a topN of 200 plus EXITED extras can fit. Status rows are free. If the window does not fit, the run is PARTIAL/OUTPUT_LIMIT and previous state is kept.", "default": 2000 } } }, "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 } } }, "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 } } } } } } } } } }