SEOmonitor API Documentation
- API version: 3.0.0
For more information, please visit https://www.seomonitor.com/
Python 2.7 and 3.4+
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com:seomonitor/python-api-sdk.git(you may need to run pip with root permission: sudo pip install git+https://github.com:seomonitor/python-api-sdk.git)
Then import the package:
import seomonitor_client Install via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import seomonitor_clientPlease follow the installation procedure and then run the following:
from __future__ import print_function
import time
import seomonitor_client
from seomonitor_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: AuthorizationToken
configuration = seomonitor_client.Configuration()
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'
# create an instance of the API class
api_instance = seomonitor_client.CampaignsApi(seomonitor_client.ApiClient(configuration))
campaign_ids = 'campaign_ids_example' # str | The Tracked Campaigns IDs for which you want the data to be returned. Please refer to the Quick Start Guide to learn how to retrieve your campaign IDs. If you do not specify `campaign_ids`, the endpoint will return the data for all active Tracked Campaigns you have access to, across all company accounts. (optional)
company_id = 56 # int | The ID of the subscription that contains the Tracked Campaigns for which you want to return data. This is useful for users who have access to multiple company accounts. Please refer to the Quick Start Guide to learn how to retrieve your company IDs. If you don't specify a `company_id`, the endpoint will return the data for all Tracked Campaigns you have access to, across all company accounts. (optional)
limit = 56 # int | The maximum number of Tracked Campaigns to return data for. Maximum Value: 100 records per request If you do not specify a `limit`, the default number of records returned per request will be 10. (optional)
offset = 56 # int | This parameter specifies the starting point within the collection of resource results. It's typically used with the `limit` parameter to implement pagination. If you do not specify an `offset`, the API will start from the first record. (optional)
try:
# Get Tracked Campaigns
api_response = api_instance.dashboard_v30_campaigns_tracked_get(campaign_ids=campaign_ids, company_id=company_id, limit=limit, offset=offset)
pprint(api_response)
except ApiException as e:
print("Exception when calling CampaignsApi->dashboard_v30_campaigns_tracked_get: %s\n" % e)All URIs are relative to https://apigw.seomonitor.com/v3
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CampaignsApi | dashboard_v30_campaigns_tracked_get | GET /dashboard/v3.0/campaigns/tracked | Get Tracked Campaigns |
| ForecastApi | forecast_v30_keywords_get | GET /forecast/v3.0/keywords | Get Forecast keywords |
| ForecastApi | forecast_v30_objective_get | GET /forecast/v3.0/objective | Get Forecast objective Data |
| ForecastApi | forecast_v30_scenario_get | GET /forecast/v3.0/scenario | Get Forecast scenario Data |
| ForecastApi | forecast_v30_scenarios_get | GET /forecast/v3.0/scenarios | Get Forecast scenarios |
| KeywordResearchApi | research_v30_domain_overview_get | GET /research/v3.0/domain-overview | Get URL/Domain Overview |
| KeywordResearchApi | research_v30_domain_ranking_keywords_get | GET /research/v3.0/domain-ranking-keywords | Get Ranking Keywords |
| KeywordResearchApi | research_v30_keywords_get | GET /research/v3.0/keywords | Get Keyword Data |
| KeywordResearchApi | research_v30_ranking_data_get | GET /research/v3.0/ranking-data | Get Ranking Data |
| KeywordResearchApi | research_v30_related_keywords_get | GET /research/v3.0/related-keywords | Get Related Keywords |
| KeywordResearchApi | research_v30_topic_overview_get | GET /research/v3.0/topic-overview | Get Topic Overview |
| KeywordVaultApi | keyword_vault_v30_get_keyword_data_by_list_get | GET /keyword-vault/v3.0/get-keyword-data-by-list | Get Keyword Data by List |
| KeywordVaultApi | keyword_vault_v30_get_overview_data_get | GET /keyword-vault/v3.0/get-overview-data | Get Overview Data |
| OrganicTrafficApi | organic_traffic_v30_daily_traffic_get | GET /organic-traffic/v3.0/daily-traffic | Get Daily Traffic Data by Segment |
| OrganicTrafficApi | organic_traffic_v30_keywords_get | GET /organic-traffic/v3.0/keywords | Get Traffic Data by Keywords |
| RankTrackerApi | rank_tracker_v30_daily_share_of_clicks_get | GET /rank-tracker/v3.0/daily-share-of-clicks | Get Daily Share of Clicks |
| RankTrackerApi | rank_tracker_v30_groups_daily_visibility_get | GET /rank-tracker/v3.0/groups/daily-visibility | Get Daily Group Visibility |
| RankTrackerApi | rank_tracker_v30_groups_data_get | GET /rank-tracker/v3.0/groups/data | Get Groups Data |
| RankTrackerApi | rank_tracker_v30_groups_get | GET /rank-tracker/v3.0/groups | Get Groups List |
| RankTrackerApi | rank_tracker_v30_keywords_competition_get | GET /rank-tracker/v3.0/keywords/competition | Get Keywords Competition Data |
| RankTrackerApi | rank_tracker_v30_keywords_daily_ranks_get | GET /rank-tracker/v3.0/keywords/daily-ranks | Get Daily Keyword Ranks |
| RankTrackerApi | rank_tracker_v30_keywords_get | GET /rank-tracker/v3.0/keywords | Get Keyword Data |
| RankTrackerApi | rank_tracker_v30_keywords_import_post | POST /rank-tracker/v3.0/keywords/import | Add New Keywords |
| RankTrackerApi | rank_tracker_v30_keywords_import_status_get | GET /rank-tracker/v3.0/keywords/import-status | Get Keywords Import Status |
| RankTrackerApi | rank_tracker_v30_keywords_ranking_pages_get | GET /rank-tracker/v3.0/keywords/ranking-pages | Get Ranking Pages |
| RankTrackerApi | rank_tracker_v30_keywords_serp_feature_presence_get | GET /rank-tracker/v3.0/keywords/serp-feature-presence | Get Daily SERP Feature Presence |
| RankTrackerApi | rank_tracker_v30_keywords_top_results_get | GET /rank-tracker/v3.0/keywords/top-results | Get Top 100 Results |
- AddCampaignPostBody
- AddKeywords
- AnalyticsData
- BestRank
- CampaignDetailsRegular
- CampaignInfo
- CampaignVisibility
- CampaignVisibilityTimeframes
- CompletionStatus30days
- CompletionStatusDateSessions
- ContentChange
- ContentChanges
- ContentLandingPageIssue
- DailyShareOfClicks
- DifficultyValue
- DomainCompetitorRank
- DomainCompetitorVisibility
- DomainOverviewTraffic
- DomainOverviewVisibility
- DomainRankingKeywordsData
- DomainRankingsData
- DomainVisibility
- ForecastAdditionalTraffic
- ForecastAdsEquivalent
- ForecastConfigConversionData
- ForecastConfiguration
- ForecastKeywordAdditionalTraffic
- ForecastKeywordAvgRank
- ForecastKeywordData
- ForecastKeywords
- ForecastMonthlyForecastTrafficSessions
- ForecastMonthlyForecasts
- ForecastMonthlyForecastsTraffic
- ForecastObjectiveData
- ForecastObjectiveDetails
- ForecastOverviewData
- ForecastOverviewInertialTraffic
- ForecastScenarioData
- ForecastScenarioSearchData
- ForecastSeoGoal
- ForecastTargetAvgRank
- ForecastTargetAvgVisibility
- ForecastTargetData
- ForecastTrafficConversions
- ForecastTrafficEstimatedAvgRanks
- ForecastTrafficRevenue
- ForecastTrafficVisibility
- Group
- GroupDailyVisibility
- GroupDetails
- GroupDetailsVisibility
- GroupKeywordCounters
- GroupsAvgRank
- GroupsDesktopVisibility
- GroupsDetailsKeywordsCounters
- GroupsFeatureVisibility
- GroupsImportPostBody
- GroupsMobileVisibility
- GroupsOpportunity
- GroupsSearchData
- GroupsSearchIntent
- GroupsSerpData
- GroupsSerpMobileDesktop
- GroupsTrafficData
- GroupsVisibility
- GroupsVolumeByDevice
- GscData
- KeywordCanibalizationLandingPageChange
- KeywordCanibalizationOnDate
- KeywordCanibalizationRankData
- KeywordCompetition
- KeywordCompetitorRankingData
- KeywordDailyRank
- KeywordDailyRankingData
- KeywordDailyRanks
- KeywordDetail
- KeywordLandingPages
- KeywordRankTrend
- KeywordRankingData
- KeywordResearchRankingData
- KeywordSerpData
- KeywordSerpFeature
- KeywordSerpResult
- KeywordTrafficData
- KeywordTrafficEcommerce
- KeywordTrafficGoals
- KeywordVaultGetKeywordDataByList
- KeywordVaultGetOverviewData
- KeywordsImportPostBody
- KeywordsImportStatus
- LandingPages
- MonthlySearches
- Objective
- ObjectiveCompletionStatus
- Opportunity
- OverviewTrafficData
- RankingKeywords
- RankingPages
- ResearchDomainOverview
- ResearchDomainRanking
- ResearchKeywords
- ResearchRankingData
- ResearchSearchData
- ResearchSerpData
- ResearchSerpFeature
- Scenarios
- SearchData
- SearchesPercentagesByDevice
- SerpFeatuersCounter
- SerpFeaturePresence
- SerpFeaturePresenceByDevice
- SerpFeaturePresenceSerpData
- ShareOfClicksDomains
- Top100Results
- TopResults
- TopicKeywordDetail
- TopicOverviewSerpData
- TopicOverviewSerpFeature
- TopicOverviewVisibility
- TopicsOverview
- TrafficEcommerce
- TrafficGoals
- TrafficKeywords
- TrafficKeywordsEcommerce
- TrafficKeywordsGoals
- TrafficOverview
- TrafficUnallocated
- VisibilityDesktopMobile
- WebsiteExplorerKeywordCompetitorData
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header