API

Documentation for the WebPresenceScore.com developer API. Use the API to run assessments and retrieve reports programmatically.

API Playground Dashboard

Documentation

Base URL: https://api.webpresencescore.com

Authentication

Send your API key on every request using either header:

  • Authorization: Bearer YOUR_API_KEY
  • X-Api-Key: YOUR_API_KEY

Free tier: 5 assessments per month, partial report. Paid tiers unlock full reports and higher limits.

Typical flow

  1. POST /api/v1/assess with {"companyName": "...", "location": "..."} → receive jobId
  2. Poll GET /api/v1/jobs/:jobId every few seconds until status is completed or failed
  3. Fetch report: GET /api/v1/reports/:assessmentId for the full or partial report JSON

Endpoints

  • POST /api/v1/assess — Enqueue an assessment job
  • GET /api/v1/jobs/:jobId — Get job status
  • GET /api/v1/reports/:assessmentId — Get report by ID
  • GET /api/v1/reports — List reports (query params: limit, offset)

Use the API Playground to try requests in the browser. For full reference, cURL examples, and sample code, see the project docs (api.md and developer-guide.md).

Manage API keys

Create and revoke API keys. Keys are scoped to your account. Sign in to access.

Base URL: https://api.webpresencescore.com. Send the key in X-Api-Key or Authorization: Bearer.

—