Skip to main content
POST
/
v2
/
geo
/
business
/
domains
Get Domain Reports
curl --request POST \
  --url https://api.writesonic.com/v2/geo/business/domains \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "project_id": "<string>",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "order_by": [
    {
      "field": "<string>",
      "order": "asc"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0
  },
  "metrics": [
    "num_answers"
  ],
  "filters": {
    "topics": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "prompts": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "tags": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "markets": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "intent": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "branded": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "platform": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "has_shopping_card": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "visibility": {
      "condition": "AND",
      "items": [
        {
          "operator": "eq",
          "value": "<unknown>"
        }
      ]
    },
    "rank": {
      "condition": "AND",
      "items": [
        {
          "operator": "eq",
          "value": "<unknown>"
        }
      ]
    },
    "website_mentioned_in_answer": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "cited_page_url": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "cited_domain": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "website_mentioned_in_citation": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "url": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    },
    "name": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    }
  }
}
'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "url": "<string>",
      "logo": "<string>",
      "created_date": "2023-12-25",
      "num_answers": 123,
      "platform_count": 123,
      "dr": 123
    }
  ],
  "info": {
    "total_rows": 123,
    "query": {
      "metrics": [
        "<string>"
      ],
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z",
      "order_by": {},
      "pagination": {},
      "filters": {}
    }
  }
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Request parameters for retrieving all domains.

​
project_id
string
required

Unique identifier of the project to query

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
start_date
string<date-time>

Start date for filtering data (ISO 8601 format). If not provided but the metrics are provided then defaults to latest run date else defaults to all time for non report APIs

Example:

"2026-01-01T00:00:00Z"

​
end_date
string<date-time>

End date for filtering data (ISO 8601 format). If not provided but the metrics are provided then defaults to latest run date else defaults to today for non report APIs

Example:

"2024-01-31T23:59:59Z"

​
order_by
SortingOrder · object[]

List of fields to sort by with their sort direction.

​
pagination
PaginationInput · object

Pagination parameters. If not provided, returns all results.

​
metrics
enum<string>[]

Metrics to include. Options: num_answers, platform_count.

Available options:
num_answers,
platform_count
Example:
["num_answers"]
​
filters
DomainFiltersInput · object

Optional filters to narrow down domains by URL or name.

Response

Successful Response

Response containing domain report data.

​
data
DomainDataItem · object[]
required

Array of domain data items

​
info
ResponseInfo · object

Information of the API request including total count and query details