{ "openapi": "3.0.1", "info": { "title": "Hex.pm Package Rankings & Download Change Monitor", "description": "Monitor Hex.pm package rankings. Track 90-day downloads, rank and version via the official Hex API.", "version": "0.1", "x-build-id": "y0K51UA0FkRYLRFEJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~hex-pm-package-rankings-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-hex-pm-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~hex-pm-package-rankings-monitor/runs": { "post": { "operationId": "runs-sync-automa-flow-hex-pm-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~hex-pm-package-rankings-monitor/run-sync": { "post": { "operationId": "run-sync-automa-flow-hex-pm-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.", "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 Hex request.", "default": "all" }, "stateNamespace": { "title": "State namespace", "pattern": "^[A-Za-z0-9_-]{1,64}$", "minLength": 1, "maxLength": 64, "type": "string", "description": "Isolates monitor history. Keep this name and the ranking settings unchanged for repeat comparisons. Use letters, numbers, '_' or '-', for example top20. Run one check at a time per namespace. Snapshot mode saves no history.", "default": "default" }, "rankingMetric": { "title": "Ranking metric", "enum": [ "recent_downloads", "total_downloads" ], "type": "string", "description": "Choose the official ranking by downloads in the last 90 days or all-time downloads. Changing the metric starts a separate monitor baseline, even with the same state namespace.", "default": "recent_downloads" }, "topN": { "title": "Top N", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many ranked packages to keep from official list page 1 when watchlist is empty. 1-100, default 20. Rank is the 1-based index in that official order, never a local sort of downloads.all. The Actor never requests page 2 or later.", "default": 20 }, "watchlist": { "title": "Package watchlist", "minItems": 0, "maxItems": 50, "type": "array", "description": "Optional Hex package names or https://hex.pm/packages/{name} URLs, 0-50. Empty means use topN. HTTP URLs and other hosts are INVALID_INPUT. A name missing from this topN window is unranked (or an EXIT candidate if it had a rank before), not NOT_FOUND while the package GET returns 200. A JSON HTTP 404 is item-level NOT_FOUND. Duplicates keep the first name.", "items": { "type": "string" } }, "maxPackageRows": { "title": "Max package rows", "minimum": 1, "maximum": 200, "type": "integer", "description": "Cap on delivered package_observation rows. Default 150 so a topN of 100 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": 150 } } }, "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 } } } } } } } } } }