Skip to main content
GET
/
api
/
v1
/
domain-metrics
/
raw
Domain Raw Metrics
curl --request GET \
  --url https://api.shareofsearch.jplus.io/api/v1/domain-metrics/raw \
  --header 'Authorization: Bearer <token>'
{
  "total_count": 123,
  "items": [
    {
      "collect_id": "<string>",
      "engine": "<string>",
      "keyword_id": "<string>",
      "rank": 123,
      "domain": "<string>",
      "url": "<string>",
      "collected_at": "2023-11-07T05:31:56Z",
      "is_ranked": true,
      "is_citation": true,
      "cited_brands": [
        "<string>"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.shareofmodel.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

collect_ids
string<uuid>[]
required

Collect Ids

Minimum array length: 1
sources
string[] | null
thematics
string[] | null
keyword_type
string[] | null
persona_ids
string[] | null
topic_ids
string[] | null
funnel_stages
string[] | null
page_number
integer | null
Required range: x >= 1
rows_per_page
integer | null
project_id
string
required

Project Id

client_id
string
required

Client id

competitor_types
enum<string>[] | null

Competitor Types

Available options:
BRANDED_WEBSITE,
COMMUNITY_HELP_CENTER,
COMPARISON_SITE,
GOVERNMENT_ACADEMIC,
INFLUENCER_CREATOR_BLOG,
NEWS_MEDIA,
PRODUCT_REVIEW_SITE,
QA_FORUM,
RETAIL_ECOMMERCE,
SPECIALIST_BLOG,
WIKI_ENCYCLOPEDIA,
UNKNOWN

Response

Successful Response

total_count
integer
required
items
RawDomainMetricItem · object[]
required