Overview

SEOmonitor API Documentation

• API version: 3.0.0

For more information, please visit https://www.seomonitor.com/

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.swagger</groupId>
  <artifactId>swagger-java-client</artifactId>
  <version>1.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.swagger:swagger-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/swagger-java-client-1.0.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CampaignsApi;

import java.io.File;
import java.util.*;

public class CampaignsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: AuthorizationToken
        ApiKeyAuth AuthorizationToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationToken");
        AuthorizationToken.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AuthorizationToken.setApiKeyPrefix("Token");

        CampaignsApi apiInstance = new CampaignsApi();
        String campaignIds = "campaignIds_example"; // String | 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.
        Integer companyId = 56; // Integer | 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.
        Integer limit = 56; // Integer | 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.
        Integer offset = 56; // Integer | 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.
        try {
            List<CampaignDetailsRegular> result = apiInstance.dashboardV30CampaignsTrackedGet(campaignIds, companyId, limit, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CampaignsApi#dashboardV30CampaignsTrackedGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://apix.seomonitor.com

Class	Method	HTTP request	Description
CampaignsApi	dashboardV30CampaignsTrackedGet	GET /dashboard/v3.0/campaigns/tracked	Get Tracked Campaigns
ForecastApi	forecastV30KeywordsGet	GET /forecast/v3.0/keywords	Get Forecast keywords
ForecastApi	forecastV30ObjectiveGet	GET /forecast/v3.0/objective	Get Forecast objective Data
ForecastApi	forecastV30ScenarioGet	GET /forecast/v3.0/scenario	Get Forecast scenario Data
ForecastApi	forecastV30ScenariosGet	GET /forecast/v3.0/scenarios	Get Forecast scenarios
KeywordResearchApi	researchV30DomainOverviewGet	GET /research/v3.0/domain-overview	Get URL/Domain Overview
KeywordResearchApi	researchV30DomainRankingKeywordsGet	GET /research/v3.0/domain-ranking-keywords	Get Ranking Keywords
KeywordResearchApi	researchV30KeywordsGet	GET /research/v3.0/keywords	Get Keyword Data
KeywordResearchApi	researchV30RankingDataGet	GET /research/v3.0/ranking-data	Get Ranking Data
KeywordResearchApi	researchV30RelatedKeywordsGet	GET /research/v3.0/related-keywords	Get Related Keywords
KeywordResearchApi	researchV30TopicOverviewGet	GET /research/v3.0/topic-overview	Get Topic Overview
KeywordVaultApi	keywordVaultV30GetKeywordDataByListGet	GET /keyword-vault/v3.0/get-keyword-data-by-list	Get Keyword Data by List
KeywordVaultApi	keywordVaultV30GetOverviewDataGet	GET /keyword-vault/v3.0/get-overview-data	Get Overview Data
OrganicTrafficApi	organicTrafficV30DailyTrafficGet	GET /organic-traffic/v3.0/daily-traffic	Get Daily Traffic Data by Segment
OrganicTrafficApi	organicTrafficV30KeywordsGet	GET /organic-traffic/v3.0/keywords	Get Traffic Data by Keywords
RankTrackerApi	rankTrackerV30DailyShareOfClicksGet	GET /rank-tracker/v3.0/daily-share-of-clicks	Get Daily Share of Clicks
RankTrackerApi	rankTrackerV30GroupsDailyVisibilityGet	GET /rank-tracker/v3.0/groups/daily-visibility	Get Daily Group Visibility
RankTrackerApi	rankTrackerV30GroupsDataGet	GET /rank-tracker/v3.0/groups/data	Get Groups Data
RankTrackerApi	rankTrackerV30GroupsGet	GET /rank-tracker/v3.0/groups	Get Groups List
RankTrackerApi	rankTrackerV30KeywordsCompetitionGet	GET /rank-tracker/v3.0/keywords/competition	Get Keywords Competition Data
RankTrackerApi	rankTrackerV30KeywordsDailyRanksGet	GET /rank-tracker/v3.0/keywords/daily-ranks	Get Daily Keyword Ranks
RankTrackerApi	rankTrackerV30KeywordsGet	GET /rank-tracker/v3.0/keywords	Get Keyword Data
RankTrackerApi	rankTrackerV30KeywordsImportPost	POST /rank-tracker/v3.0/keywords/import	Add New Keywords
RankTrackerApi	rankTrackerV30KeywordsImportStatusGet	GET /rank-tracker/v3.0/keywords/import-status	Get Keywords Import Status
RankTrackerApi	rankTrackerV30KeywordsRankingPagesGet	GET /rank-tracker/v3.0/keywords/ranking-pages	Get Ranking Pages
RankTrackerApi	rankTrackerV30KeywordsSerpFeaturePresenceGet	GET /rank-tracker/v3.0/keywords/serp-feature-presence	Get Daily SERP Feature Presence
RankTrackerApi	rankTrackerV30KeywordsTopResultsGet	GET /rank-tracker/v3.0/keywords/top-results	Get Top 100 Results

Documentation for Models

• 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

Documentation for Authorization

Authentication schemes defined for the API:

AuthorizationToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]