{ "openapi": "3.0.1", "info": { "title": "College Outcomes Comparator", "description": "Compare colleges using structured outcomes metrics such as completion, earnings, debt, retention, cost, admission, and program-level indicators from supplied datasets or official-data exports.", "version": "1.0", "x-build-id": "CHaEQsudysPCKH62n" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~college-outcomes-comparator/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-college-outcomes-comparator", "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/junipr~college-outcomes-comparator/runs": { "post": { "operationId": "runs-sync-junipr-college-outcomes-comparator", "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/junipr~college-outcomes-comparator/run-sync": { "post": { "operationId": "run-sync-junipr-college-outcomes-comparator", "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": { "institutionNames": { "title": "Institution Names", "type": "array", "description": "Institution Names controls College Outcomes Comparator processing for the supplied inputs; keep values conservative for first runs.", "items": { "type": "string" }, "default": [ "Harvard University", "Massachusetts Institute of Technology", "Stanford University" ] }, "unitIds": { "title": "Unit IDs", "type": "array", "description": "Unit IDs controls College Outcomes Comparator processing for the supplied inputs; keep values conservative for first runs.", "items": { "type": "string" }, "default": [ "166027", "166683", "243744" ] }, "opeIds": { "title": "Ope IDs", "type": "array", "description": "Ope IDs controls College Outcomes Comparator processing for the supplied inputs; keep values conservative for first runs.", "items": { "type": "string" }, "default": [] }, "outcomesCsvUrl": { "title": "Outcomes CSV URL", "type": "string", "description": "Public outcomes CSV URL to fetch or inspect for College Outcomes Comparator.", "default": "" }, "outcomesJson": { "title": "Outcomes JSON", "type": "array", "description": "Inline outcomes JSON object used by College Outcomes Comparator.", "items": { "type": "object" }, "default": [ { "institutionName": "Harvard University", "unitId": "166027", "sourceYear": 2023, "metrics": { "completion_rate": 0.9745, "median_earnings": 101817, "median_debt": 14000 }, "source": "U.S. Department of Education College Scorecard latest public API" }, { "institutionName": "Massachusetts Institute of Technology", "unitId": "166683", "sourceYear": 2023, "metrics": { "completion_rate": 0.9624, "median_earnings": 143372, "median_debt": 14768 }, "source": "U.S. Department of Education College Scorecard latest public API" }, { "institutionName": "Stanford University", "unitId": "243744", "sourceYear": 2023, "metrics": { "completion_rate": 0.9237, "median_earnings": 124080, "median_debt": 12000 }, "source": "U.S. Department of Education College Scorecard latest public API" } ] }, "metrics": { "title": "Metrics", "type": "array", "description": "Metrics controls College Outcomes Comparator processing for the supplied inputs; keep values conservative for first runs.", "items": { "type": "string" }, "default": [ "completion_rate", "median_earnings", "median_debt" ] }, "cohortYear": { "title": "Cohort Year", "minimum": 0, "type": "integer", "description": "Cohort Year controls College Outcomes Comparator processing for the supplied inputs; keep values conservative for first runs.", "default": 2023 }, "peerGroupMode": { "title": "Peer Group Mode", "type": "string", "description": "Peer Group Mode controlling how College Outcomes Comparator processes the supplied inputs.", "default": "supplied institutions" }, "includeDebtMetrics": { "title": "Include Debt Metrics", "type": "boolean", "description": "Include debt metrics in output rows or reports when available.", "default": true }, "includeEarningsMetrics": { "title": "Include Earnings Metrics", "type": "boolean", "description": "Include earnings metrics in output rows or reports when available.", "default": true }, "missingValuePolicy": { "title": "Missing Value Policy", "type": "string", "description": "Missing Value Policy that determines how findings are classified.", "default": "include" }, "maxInstitutions": { "title": "Max Institutions", "minimum": 0, "type": "integer", "description": "Maximum institutions to process in one run; keep defaults low for safe first runs.", "default": 3 }, "maxChargeUsd": { "title": "Max Charge USD", "minimum": 0, "maximum": 100000, "type": "number", "description": "Maximum pay-per-event charge allowed before the actor stops without emitting unpaid output.", "default": 1 } } }, "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 } } } } } } } } } }