{
"openapi": "3.0.1",
"info": {
"title": "SiteVerdict — GitHub Repo Analytics & Star History",
"description": "Compare GitHub repos with the official API: stars, forks, open issues vs PRs, PR merge speed, issue close time, contributors, releases and commit activity. Org scans, growth tracking and alerts for star spikes and new releases. Token optional; star history needs one.",
"version": "1.1",
"x-build-id": "HnvTvXDepZxXZCceW"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/siteverdict~siteverdict-github-repo-analytics/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-github-repo-analytics",
"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/siteverdict~siteverdict-github-repo-analytics/runs": {
"post": {
"operationId": "runs-sync-siteverdict-siteverdict-github-repo-analytics",
"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/siteverdict~siteverdict-github-repo-analytics/run-sync": {
"post": {
"operationId": "run-sync-siteverdict-siteverdict-github-repo-analytics",
"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": {
"executionMode": {
"title": "Execution mode",
"enum": [
"live",
"sample"
],
"type": "string",
"description": "live: call the GitHub API. sample: synthetic repositories with history (shows alerts; no calls, nothing charged).",
"default": "live"
},
"repos": {
"title": "Repositories",
"type": "array",
"description": "owner/name or github.com URLs (max 100). Put your repo and your competitors here.",
"items": {
"type": "string"
}
},
"orgs": {
"title": "Organisations or users to scan",
"type": "array",
"description": "Lists their public repositories (one cheap row each, sorted by stars) and deep-analyses the top N.",
"items": {
"type": "string"
}
},
"githubToken": {
"title": "GitHub token (optional)",
"type": "string",
"description": "A fine-grained or classic token with public read access only. Raises the limit from 60 to 5,000 requests/hour. Never logged or output."
},
"maxReposPerOrg": {
"title": "Max repos listed per org",
"minimum": 1,
"maximum": 2000,
"type": "integer",
"description": "Org scan size (100 per API call).",
"default": 100
},
"deepAnalyseTopN": {
"title": "Deep-analyse top N repos per org",
"minimum": 0,
"maximum": 100,
"type": "integer",
"description": "Full report (PRs, issues, contributors, releases, star history) for the most-starred non-fork repos of each org.",
"default": 5
},
"starHistory": {
"title": "Star history",
"type": "boolean",
"description": "Sample the stargazers API to build a star curve and stars gained in 30/90 days. Needs a GitHub token: GitHub refuses the stargazers list to anonymous requests (without a token the rows say so and every other metric still works).",
"default": true
},
"starHistorySamples": {
"title": "Star history sample pages",
"minimum": 2,
"maximum": 30,
"type": "integer",
"description": "API calls per repo for the star curve (more = smoother).",
"default": 6
},
"commitActivity": {
"title": "Commit activity",
"type": "boolean",
"description": "Commits in the last 12 and 52 weeks (GitHub may need a second run to compute stats for rarely viewed repos).",
"default": true
},
"includeContributors": {
"title": "Include top contributor usernames",
"type": "boolean",
"description": "Off by default (usernames are personal data). Counts are always included.",
"default": false
},
"maxApiCalls": {
"title": "Max GitHub API calls per run",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Defaults to 55 without a token and 1,000 with one. A deep report costs about 9-14 calls."
},
"starAlertMin": {
"title": "Star spike alert (stars)",
"minimum": 1,
"type": "integer",
"description": "Alert when a repo gains at least this many stars since the previous run.",
"default": 50
},
"starAlertPct": {
"title": "Star spike alert (%)",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "…or at least this percentage (and 5+ stars).",
"default": 5
},
"alertOnRelease": {
"title": "Alert on new releases",
"type": "boolean",
"description": "Alert when the latest release tag changes.",
"default": true
},
"webhookUrl": {
"title": "Webhook URL (HTTPS)",
"type": "string",
"description": "Optional JSON POST with alerts. Private and internal addresses are blocked."
},
"slackWebhookUrl": {
"title": "Slack incoming webhook URL",
"type": "string",
"description": "Optional. https://hooks.slack.com/services/..."
},
"stateStoreName": {
"title": "History store",
"type": "string",
"description": "Named key-value store for growth tracking between runs.",
"default": "siteverdict-github-history"
},
"aiProvider": {
"title": "AI brief (optional, your own key)",
"enum": [
"none",
"anthropic",
"openai"
],
"type": "string",
"description": "Off by default. A comparison briefing with a verdict per repo, written from this run's metrics with YOUR Anthropic or OpenAI key.",
"default": "none"
},
"aiApiKey": {
"title": "AI API key",
"type": "string",
"description": "Your own Anthropic or OpenAI API key. Never logged or output."
},
"aiModel": {
"title": "AI model (optional)",
"type": "string",
"description": "Defaults: claude-sonnet-5-5 (Anthropic) or gpt-4o-mini (OpenAI)."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}