SEOmonitor API 3.0
  1. Schemas
SEOmonitor API 3.0
  • Overview
  • Campaigns
    • Get Tracked Campaigns
  • Rank Tracker
    • Get Keyword Data
    • Get Keyword AI Overview Data
    • Get Keyword AI Search Data
    • Get Groups List
    • Get Keywords Competition Data
    • Get Keywords Competition Data AI Overview
    • Get Keywords Competition AI Search Data
    • Get Top 100 Results
    • Get Groups Data
    • Get Daily Keyword Ranks
    • Get Daily Keyword Ranks AI Overview
    • Get Daily AI Search Keyword Ranks
    • Get Daily Group Visibility
    • Get Daily Group Visibility AI Overview Mentions
    • Get Daily Group Visibility AI Overview Citations
    • Add New Keywords
    • Get Keywords Import Status
    • Get Daily SERP Feature Presence
    • Get Ranking Pages
    • Get Daily Share of Clicks
    • Get Share of Voice
    • Get Daily Group AI Search Brand Mentions visibility
    • Get Daily Group AI Search Site Citations visibility
    • Get SERP Visibility Data
  • Organic Traffic
    • Get Daily Traffic Data by Segment
    • Get Traffic Data by Keywords
  • Research
    • Keyword Research
      • By Topic
        • Get Related Keywords
        • Get Topic Overview
      • By URL
        • Domain
          • Get URL/Domain Overview
          • Get Ranking Keywords
      • Get Keyword Data
      • Get Ranking Data
    • Keyword Vault
      • Get Keyword Data by List
      • Get Overview Data
  • Forecast
    • Get Forecast scenarios
    • Get Forecast scenario Data
    • Get Forecast objective Data
    • Get Forecast keywords
  • AI Writer
    • Generate Outlines and Articles
    • Get Generation Status
    • Get Article Content
    • Get Topic Recommendations
  • Get URL/Domain Overview
    GET
  • Get Ranking Keywords
    GET
  • Schemas
    • Schemas
      • Root Type for campaign-visibility-timeframes
      • Root Type for campaign-details-regular
      • Root Type for group-details
      • Root Type for group-details-visibility
      • Root Type for serp-featuers-counter
      • Root Type for keyword-detail
      • Root Type for keyword-ranking-data
      • Root Type for keyword-rank-trend
      • Root Type for keyword-traffic-data
      • Root Type for keyword-landing-pages
      • Root Type for keyword-canibalization-on-date
      • Root Type for topic-keyword-detail
      • Root Type for content-landing-page-issue
      • Root Type for content_changes
      • Root Type for traffic-keywords
      • Traffic Unallocated
      • Root Type for traffic-overview
      • Root Type for campaign-visibility
      • Root Type for groups-search-data
      • Root Type for groups-serp-data
      • Root Type for groups-traffic-data
      • Root Type for keyword-daily-ranks
      • Root Type for keyword-daily-ranks-mobile-desktop
      • Root Type for daily-visibility
      • Root Type for ranking-pages
      • Root Type for analytics-data
      • Root Type for website-explorer-keywords
      • Root Type for research-serp-data
      • Root Type for research-search-data
      • Root Type for Website-explorer-overview
      • Root Type for Topics-explorer-overview
      • Root Type for research-domain-overview
      • Root Type for domain-overview-traffic
      • Root Type for domain-overview-visibility
      • Root Type for domain-rankings-data
      • Root Type for domain-ranking-keywords-data
      • Root Type for keyword-vault-get-overview-data
      • keyword-vault-get-keyword-data-by-list
      • Root Type for forecast-keyworfs
      • Root Type for forecast-scenario-data
      • Root Type for forecast-seo-goal
      • Root Type for forecast-scenario-search-data
      • Root Type for forecast-target-data
      • Root Type for forecast-configuration
      • Root Type for forecast-overview-data
      • Root Type for monthly-forecast
      • Root Type for monthly-forecast-traffic
      • Root Type for daily-share-of-clicks
      • Root Type for forecast-scenario-data
      • Root Type for forecast-objective-details
      • Root Type for objective-completion-status
      • Root Type for visibility-desktop-mobile
      • Root Type for group
      • Root Type for groups-details-keywords-counters
      • Root Type for searches-percentages-by-device
      • Root Type for opportunity
      • Root Type for keyword-traffic-ecommerce
      • Root Type for keyword-traffic-goals
      • Root Type for keyword-serp-feature
      • Root Type for keyword-canibalization-rank-data
      • Root Type for keyword-canibalization-landing-page-change
      • Root Type for keyword-competition
      • Root Type for keyword-serp-result
      • Root Type for keyword-competitor-ranking-data
      • Root Type for keywords-import-status
      • Root Type for add-keywords
      • Root Type for domain-visibility
      • Root Type for add-campaign-post-biody
      • Root Type for keywords-import-post-body
      • campaign-info
      • Root Type for keywords-import-post-body
      • Root Type for Website-explorer-keyword-domain
      • Root Type for objective
      • Root Type for search-data
      • Root Type for difficulty-value
      • Root Type for content_change
      • Ecommerce
      • Goals
      • Traffic Ecommerce
      • Traffic Goals
      • Root Type for keyword-serp-feaftures
      • Root Type for sesonality-trend
      • Root Type for best_rank
      • Root Type for landing-pages
      • Root Type for top-results
      • Root Type for top-100-results
      • Root Type for group_keyword_counters
      • groups-opportunity
      • Root Type for groups-volume-by-device
      • Root Type for groups-search-intent
      • Root Type for groups-desktop-mobile-visibility
      • Root Type for groups-mobile-visibility
      • Root Type for groups-serp-mobile-desktop
      • Root Type for keyword-daily-rank
      • Root Type for groups-visibility
      • Root Type for groups-avg-rank
      • Root Type for groups-feature-visibility
      • Root Type for ranking-keywords
      • Root Type for serp-feature-presence
      • Root Type for serp-feature-presence-by-device
      • Root Type for serp-feature-presence-mobile-desktop
      • Root Type for gsc-data
      • Root Type for research-ranking-data
      • Root Type for research-serp-feature
      • Root Type for research-domain-ranking
      • Root Type for topic-overview-serp
      • Root Type for topic-overview-serp-feature
      • Root Type for topic-overview-visibility
      • Root Type for overview-traffic-data
      • Root Type for domain-competitor-visibility
      • Root Type for domain-competitor-rank
      • Root Type for forecast-keyword-data
      • Root Type for forecast-keyword-avg-rank
      • Root Type for forecast-keyword-additional-traffic
      • Root Type for forecast-target-avg-rank
      • Root Type for forecast-target-avg-visibility
      • Root Type for forecast-config-conversion-data
      • Root Type for forecast-additional-traffic
      • Root Type for forecast-overview-inertial-traffic
      • Root Type for forecast-ads-equivalent
      • Root Type for forecast-
      • Root Type for forecast-traffic-revenue
      • Root Type for forecast-traffic-visibility
      • Root Type for forecast-traffic-estimated_avg_ranks
      • Root Type for Scenarios
      • Root Type for monthly-forecast-traffic-sessions
      • Root Type for share-of-clicks-domains
      • Root Type for completion-status-30days
      • Root Type for completion-status-date-sessions
    • RequestBodies
      • Body
    • SerpVisibilityResponse
    • SerpVisibilityDataItem
    • SerpVisibilityMeta
    • ErrorResponse
  1. Schemas

campaign-details-regular(Root Type for campaign-details-regular)

"[\n    {\n        \"campaign_info\": {\n            \"id\": 102933,\n            \"name\": \"seomonitor.com\",\n            \"company\": \"SEOmonitor\",\n            \"company_id\": 20077,\n            \"url\": \"https://seomonitor.com\",\n            \"keywords_number\": 703,\n            \"date_created\": \"2021-12-17\",\n            \"date_available_reporting\": \"February 1\",\n        },\n        \"visibility\": {\n            \"weekly\": {\n                \"desktop\": {\n                    \"visibility\": 53.4,\n                    \"performance\": -0.98\n                },\n                \"mobile\": {\n                    \"visibility\": 54.8,\n                    \"performance\": 0.09\n                }\n            },\n            \"monthly\": {\n                \"desktop\": {\n                    \"visibility\": 53.4,\n                    \"performance\": 1.3\n                },\n                \"mobile\": {\n                    \"visibility\": 54.8,\n                    \"performance\": 4.3\n                }\n            }\n        },\n        \"objective\": {\n            \"date_created\": \"2022-06-17\",\n            \"date_start\": \"2022-06-30\",\n            \"date_end\": \"2023-06-30\",\n            \"date_deleted\": \"2022-07-01\",\n            \"is_objective\": false,\n            \"monthly_budget\": \"5000\",\n            \"chance\": 29.26,\n            \"created_by\": {\n                \"name\": \"Jane Example\"\n            },\n            \"status\": {\n                \"completed\": false,\n                \"last_30_days\": {\n                    \"actual_sessions\": 0,\n                    \"forecasted_sessions\": 0,\n                    \"percentage\": 0\n                },\n                \"timeframe\": {\n                    \"actual_sessions\": 0,\n                    \"forecasted_sessions\": 0,\n                    \"percentage\": 0\n                }\n            }\n        },\n        \"monthly_recurring_revenue\": 5000,\n        \"health_status\": \"average\",\n        \"reporting\": {\n            \"site_id\": 30800,\n            \"report_hash\": null,\n            \"due_date\": 1,\n            \"status\": 0,\n            \"created_by\": null,\n            \"insights_count\": null,\n            \"likes_count\": null,\n            \"seen_count\": null,\n            \"last_status_changed_date\": null,\n            \"status_description\": {\n                \"status_text\": \"Overdue\",\n                \"date_text\": \"14d\",\n                \"status\": 0\n            }\n        },\n        \"account_manager\": {\n            \"full_name\": \"Jon Example\",\n            \"email\": \"jon@seomonitor.com\",\n            \"job_title\": \"\",\n            \"last_seen\": \"2 days ago\"\n        },\n        \"location\": \"Romania\",\n        \"multiple_locations_campaigns\": [\n            {\n                \"site_id\": \"106411\",\n                \"location\": \"Ploiesti\",\n                \"location_long\": \"Ploiesti, Prahova, RO\",\n                \"uule_id\": 185411,\n                \"processing\": false,\n                \"search_data\": \"Ploiesti, Romania\",\n                \"search_data_short\": \"RO\",\n                \"vscore\": \"36.1\",\n                \"change\": \"4.1\",\n                \"showVscore\": true\n            }\n        ]\n    }\n]"
Built with