Skip to main content
GET
/
api
/
agent
/
gsc
/
report
Get GSC performance report
curl --request GET \
  --url https://www.citedy.com/api/agent/gsc/report \
  --header 'Authorization: Bearer <token>'
{
  "connected": true,
  "reportDate": "2023-12-25",
  "summary": {
    "clicks": 123,
    "impressions": 123,
    "ctr": 123,
    "position": 123,
    "clicksChangePct": 123,
    "impressionsChangePct": 123
  },
  "cached": true,
  "gscProperty": "<string>",
  "rangeDays": 123,
  "topQueries": [
    {
      "query": "<string>",
      "clicks": 123,
      "impressions": 123,
      "ctr": 123,
      "position": 123
    }
  ],
  "topPages": [
    {
      "page": "<string>",
      "clicks": 123,
      "impressions": 123,
      "ctr": 123,
      "position": 123
    }
  ],
  "movers": {
    "gainers": [
      {}
    ],
    "losers": [
      {}
    ]
  },
  "opportunities": [
    {}
  ],
  "articleSuggestions": [
    {
      "keyword": "<string>",
      "reason": "<string>",
      "impressions": 123,
      "position": 123,
      "opportunityScore": 123,
      "workflow": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://www.citedy.com/docs/llms.txt

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

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Query Parameters

force_refresh
boolean

Force fresh GSC data fetch instead of cached morning report

Response

GSC report (connected) or connect URL (not connected)

connected
enum<boolean>
required
Available options:
true
reportDate
string<date>
required
summary
object
required
cached
boolean
gscProperty
string
rangeDays
integer
topQueries
object[]
topPages
object[]
movers
object
opportunities
object[]
articleSuggestions
object[]