Skip to content
Zaraftis API
Esc
↑↓navigate↵open⌘Jpreview

Get a scan's metrics

GET/scans/{scan_id}/metrics
Authorization
AuthorizationBearer token · headerrequired

API key sent as Authorization: Bearer <key>. A key belongs to one workspace, has scopes, and can be limited to some brands.

or
AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 sign-in (authorization code with PKCE) used by AI assistants that connect through the Zaraftis MCP server. Discovery URLs are at https://api.zaraftis.com/api/auth.

Path parameters
scan_idstring<uuid>required
Query parameters
detailstring

compact (default) or detailed. Where a route returns more with detailed, its response description says what is added.

Allowed:compactdetailed
Responses
200

The stored metric fields with per-platform breakdowns

successbooleanrequired
dataScanMetricsObjectrequired
Show properties
brand_mention_rateobjectrequired
Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
by_platformobjectrequired
brand_citation_rateMetricFieldrequired

value is null when the metric is not persisted yet.

Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
brand_citation_shareobjectrequired
Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
by_platformobjectrequired
mention_positionobjectrequired
Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
by_platformobjectrequired
share_of_voiceMetricFieldrequired

value is null when the metric is not persisted yet.

Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
sentiment_breakdownMetricFieldrequired

value is null when the metric is not persisted yet.

Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
unique_cited_domainsMetricFieldrequired

value is null when the metric is not persisted yet.

Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
answers_receivedMetricFieldrequired

value is null when the metric is not persisted yet.

Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
coverageMetricFieldrequired

value is null when the metric is not persisted yet.

Show properties
valuenumber | object | nullrequired
Show properties
Any of:
number
number
object
object
null
null
qualitystring | nullrequired
Show properties
Any of:
string
string
null
null
method_versionstring | nullrequired
Show properties
Any of:
string
string
null
null
request_idstringrequired
min length 1
404

not_found: unknown id, or an id this key cannot see

successbooleanrequired
errorobjectrequired
Show properties
codestringrequired
messagestringrequired
retryablebooleanrequired
detailsobject
field_errorsobject[]
Show properties
Array of object
fieldstringrequired
codestringrequired
Allowed:requiredformattoo_smalltoo_largeunrecognized_keyinvalid
messagestringrequired
request_idRequestIdrequired
Request
curl -X GET 'https://api.zaraftis.com/v1/scans/497f6eca-6276-4993-bfeb-53cbbbba6f08/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "success": true,
  "data": {
    "brand_mention_rate": {
      "value": 0,
      "quality": "complete",
      "method_version": "string",
      "by_platform": {
        "property1": {
          "value": 0,
          "votes": -9007199254740991
        },
        "property2": {
          "value": 0,
          "votes": -9007199254740991
        }
      }
    },
    "brand_citation_rate": {
      "value": 0,
      "quality": "complete",
      "method_version": "string"
    },
    "brand_citation_share": {
      "value": 0,
      "quality": "complete",
      "method_version": "string",
      "by_platform": {
        "property1": {
          "value": 0,
          "votes": -9007199254740991
        },
        "property2": {
          "value": 0,
          "votes": -9007199254740991
        }
      }
    },
    "mention_position": {
      "value": 0,
      "quality": "complete",
      "method_version": "string",
      "by_platform": {
        "property1": {
          "value": 0,
          "votes": -9007199254740991
        },
        "property2": {
          "value": 0,
          "votes": -9007199254740991
        }
      }
    },
    "share_of_voice": {
      "value": 0,
      "quality": "complete",
      "method_version": "string"
    },
    "sentiment_breakdown": {
      "value": 0,
      "quality": "complete",
      "method_version": "string"
    },
    "unique_cited_domains": {
      "value": 0,
      "quality": "complete",
      "method_version": "string"
    },
    "answers_received": {
      "value": 0,
      "quality": "complete",
      "method_version": "string"
    },
    "coverage": {
      "value": 0,
      "quality": "complete",
      "method_version": "string"
    }
  },
  "request_id": "string"
}

Was this page helpful?