Skip to main content
POST
/
v2
/
geo
/
reports
/
performance
Get Performance Report
curl --request POST \
  --url https://api.writesonic.com/v2/geo/reports/performance \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "project_id": "<string>",
  "dimensions": [
    "topic"
  ],
  "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
  },
  "measures": [
    "share_of_voice"
  ],
  "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>"
        }
      ]
    },
    "status": {
      "condition": "AND",
      "items": [
        {
          "operator": "is",
          "value": "<unknown>"
        }
      ]
    }
  },
  "date_aggregation_interval": "day",
  "website_type": "SELF"
}
'
{
  "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": {}
    }
  },
  "data": [
    {
      "topic_id": "<string>",
      "topic_name": "<string>",
      "tag_id": "<string>",
      "tag_name": "<string>",
      "market_id": "<string>",
      "market_name": "<string>",
      "model_id": "<string>",
      "model_name": "<string>",
      "query_id": "<string>",
      "query_name": "<string>",
      "date": "<string>",
      "website_id": "<string>",
      "website_name": "<string>",
      "share_of_voice": 123,
      "citation_share": 123,
      "mention_count": 123,
      "visibility_score": 123,
      "citation_count": 123,
      "rank": 123,
      "citing_answers": 123,
      "number_of_answers": 123
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Request parameters for the Performance Report API.

​
project_id
string
required

Unique identifier of the project to query

Example:

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

​
dimensions
enum<string>[]
required

Dimensions to group results by. At least one dimension is required.

Minimum array length: 1
Available options:
topic,
tag,
market,
model,
query,
date,
website
Examples:
["model", "market"]
["topic", "date"]
​
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.

​
measures
enum<string>[]

Performance metrics to include in the response. If empty, all measures are returned.

Available options:
share_of_voice,
citation_share,
mention_count,
visibility_score,
citation_count,
rank,
citing_answers,
number_of_answers
Example:
["share_of_voice", "visibility_score"]
​
filters
PerformanceFiltersInput · object

Optional filters to narrow down the results by topics, markets, tags, etc.

​
date_aggregation_interval
enum<string>

Time interval for aggregating data when using 'date' dimension. Options: day, week, month.

Available options:
day,
week,
month
Example:

"week"

​
website_type
enum<string>

Filter by website type. SELF for your brand only, SELF+COMPETITORS for all tracked websites.

Available options:
SELF,
SELF+COMPETITORS
Example:

"SELF"

Response

Successful Response

Response containing performance report data.

​
info
ResponseInfo · object

Information of the API request including total count and query details

​
data
PerformanceDataRow · object[]

Array of performance data rows grouped by the requested dimensions