Developer Marketing1.0.0-beta.1

Run a passive website inspection on an authorized host

Analyzes one public HTML page and bounded discovery files within the approved Space host. A managed domain permits its www alias. Redirects and ancillary requests are checked at every hop. Raw response content and share images are excluded. Explicitly request history to retain a summary.

POST/api/v1/marketing/site-inspections

Workspace automation for approved Dashio products. Each token is scoped to one Space and independently granted operations. Requests spend shared minute credits, and selected operation groups also share hourly quotas.

Required token scope is marketing:inspections:run. Scopes are independent.

Conditional token scope marketing:inspections:save. Required when options.saveHistory is true.

This operation uses 15 credits from a shared budget of 60 credits per token and 300 per Space each UTC minute. The inspection group shares 8 requests per token and 20 per Space each UTC hour.

Run these examples on a trusted server with DASHIO_API_TOKEN configured. Use a private terminal when inspecting response data. Examples send one request with a bounded timeout and do not retry automatically.

Authentication

Dashio developer token (HTTP Bearer) API authentication guide

Path parameters

None documented.

Query parameters

None documented.

Header parameters

None documented.

Request body

application/json · Required

urlstring (uri)Required: Absolute HTTP(S) address on a default port. The hostname must be managed or currently verified in this Space. Credentials, query strings and fragments are disallowed. Minimum length: 1. Maximum length: 2048.
optionsobjectOptional: No field description supplied.

Request & response examples

Copy an example in your preferred language.

request.sh

: "${DASHIO_API_TOKEN:?Set DASHIO_API_TOKEN before running this example}"

curl --fail-with-body --include --silent --show-error --connect-timeout 10 --max-time 30 \
  --request POST 'https://app.dashio.net/api/v1/marketing/site-inspections' \
  --header "Authorization: Bearer $DASHIO_API_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "https://example.com/",
  "options": {
    "verifySitemap": true,
    "saveHistory": false
  }
}'

Replace URL parameters, credentials, and schema placeholders before running. No request is sent by this page.

Schema-generated example; not a captured response.

{
  "requestedUrl": "https://example.com/",
  "finalUrl": "https://example.com/",
  "statusCode": 100,
  "responseTimeMs": 0,
  "redirects": [
    {
      "url": "https://example.com/",
      "statusCode": 0
    }
  ],
  "inspectedAt": "2026-01-01T12:00:00Z",
  "preview": {
    "title": "<title>",
    "description": "<description>",
    "siteName": "<siteName>",
    "hostname": "<hostname>",
    "imageDeclared": false
  },
  "summary": {
    "score": 0,
    "passed": 0,
    "warnings": 0,
    "failed": 0
  },
  "checks": [
    {
      "id": "<id>",
      "category": "seo",
      "status": "pass",
      "label": "<label>",
      "detail": "<detail>"
    }
  ],
  "historySaveStatus": "not-requested",
  "historyId": "d40beec9-3477-45cb-92e4-152f5b9d0686"
}

Run examples on a trusted server. Configure the environment variables and replace URL or schema placeholders. For a write, reuse its saved idempotency key only when retrying the identical request.

Responses

Headers on every response

X-Request-Idstring (uuid)Optional: Server-generated ID to include in a support request.

200

Passive observations, a score and optional history-save receipt.

Response headers

RateLimit-LimitintegerOptional: Per-token capacity in the reported gateway window, expressed in requests of this operation. A shared Space budget also applies. Present when the request reaches the authenticated gateway. Minimum: 1.
RateLimit-RemainingintegerOptional: Requests of this operation remaining under the current token, Space and applicable operation-group quotas. Present when the request reaches the authenticated gateway. Minimum: 0.
RateLimit-ResetintegerOptional: Unix timestamp in seconds when the reported gateway quota resets. Present when the request reaches the authenticated gateway. Minimum: 0.

application/json

requestedUrlstring (uri)Required: No field description supplied.
finalUrlstring (uri)Required: No field description supplied.
statusCodeintegerRequired: Minimum: 100. Maximum: 599.
responseTimeMsintegerRequired: Minimum: 0.
redirectsarray of objectRequired: Maximum items: 4.
inspectedAtstring (date-time)Required: No field description supplied.
previewobjectRequired: No field description supplied.
summaryobjectRequired: No field description supplied.
checksarray of objectRequired: No field description supplied.
historySaveStatusstringRequired: Allowed values: "not-requested", "saved", "failed".
historyIdstring | null (uuid)Required: No field description supplied.

400

Unsupported parameters or invalid request data.

application/json

statusCodeintegerRequired: Minimum: 400. Maximum: 599.
statusMessagestringOptional: A safe explanation suitable for display.
dataobjectRequired: No field description supplied.

401

A valid developer token is required.