def test_domain_from_url(self):
# should raise exceptions for invalid url
self.assertRaises(InvalidURLException, utils.domain_from_url, "INVALID")
# should return root domain
self.assertEqual(utils.domain_from_url("google.com"), "google.com")
self.assertEqual(utils.domain_from_url("http://google.com/sg/?q=search"), "google.com")
self.assertEqual(utils.domain_from_url("http://sg.google.com/page/?q=search"), "google.com")
def test_domain_from_url(self):
# should raise exceptions for invalid url
self.assertRaises(InvalidURLException, utils.domain_from_url,
"INVALID")
# should return root domain
self.assertEqual(utils.domain_from_url("google.com"), "google.com")
self.assertEqual(
utils.domain_from_url("http://google.com/sg/?q=search"),
"google.com")
self.assertEqual(
utils.domain_from_url("http://sg.google.com/page/?q=search"),
"google.com")
def __init__(self, api_key, domain, start_month, end_month,
main_domain_only=False, results_page=None):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
results_page: integer
Enter for more than 10 results
"""
self.domain = utils.domain_from_url(domain)
self.start_month = start_month
self.end_month = end_month
self.main_domain_only = main_domain_only
self.results_page = results_page
super(ReferralsAPI, self).__init__(api_key)
def __init__(self, api_key, domain, start_month, end_month,
time_granularity="MONTHLY", main_domain_only=False):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
time_granularity: string
Time granularity of report. Can be: Daily, Weekly, Monthly
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
"""
self.domain = utils.domain_from_url(domain)
self.start_month = start_month
self.end_month = end_month
self.time_granularity = time_granularity
self.main_domain_only = main_domain_only
super(TrafficAPI, self).__init__(api_key)
def __init__(self,
api_key,
domain,
start_month,
end_month,
main_domain_only=False,
results_page=None):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
results_page: integer
Enter for more than 10 results
"""
self.domain = utils.domain_from_url(domain)
self.start_month = start_month
self.end_month = end_month
self.main_domain_only = main_domain_only
self.results_page = results_page
super(ReferralsAPI, self).__init__(api_key)
def __init__(self,
api_key,
domain,
start_month,
end_month,
time_granularity="MONTHLY",
main_domain_only=False):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
time_granularity: string
Time granularity of report. Can be: Daily, Weekly, Monthly
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
"""
self.domain = utils.domain_from_url(domain)
self.start_month = start_month
self.end_month = end_month
self.time_granularity = time_granularity
self.main_domain_only = main_domain_only
super(TrafficAPI, self).__init__(api_key)
def __init__(self, api_key, domain):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
"""
self.domain = utils.domain_from_url(domain)
super(RankAndReachAPI, self).__init__(api_key)
def __init__(self, api_key, domain):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
"""
self.domain = utils.domain_from_url(domain)
super(WebsiteCategorizationAPI, self).__init__(api_key)
def __init__(self, api_key, domain):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
"""
self.domain = utils.domain_from_url(domain)
super(DestinationsAPI, self).__init__(api_key)
def __init__(self,
api_key,
endpoint,
domain,
start_month,
end_month,
main_domain_only=False,
results_page=None):
"""
Parameters
----------
api_key: string
SimilarWeb API key
endpoint: string
Endpoint to use. Can be: orgkwcompetitor, paidkwcompetitor
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
results_page: integer
Enter for more than 10 results
"""
if endpoint not in [
"orgkwcompetitor",
"paidkwcompetitor",
]:
raise InvalidEndpointException(
"Endpoint must be one of the following values: "
"orgkwcompetitor, paidkwcompetitor")
self.domain = utils.domain_from_url(domain)
self.endpoint = endpoint
self.start_month = start_month
self.end_month = end_month
self.main_domain_only = main_domain_only
self.results_page = results_page
super(KeywordCompetitorsAPI, self).__init__(api_key)
def __init__(self, api_key, domain, app_store_id):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
app_store_id: integer
0 for Google Play Store, 1 for iOS AppStore
"""
self.domain = utils.domain_from_url(domain)
self.app_store_id = app_store_id
super(RelatedSiteAppsAPI, self).__init__(api_key)
def __init__(self, api_key, domain, app_store_id):
"""
Parameters
----------
api_key: string
SimilarWeb API key
domain: string
Domain to query.
app_store_id: integer
0 for Google Play Store, 1 for iOS AppStore
"""
self.domain = utils.domain_from_url(domain)
self.app_store_id = app_store_id
super(RelatedSiteAppsAPI, self).__init__(api_key)
def __init__(self,
api_key,
endpoint,
domain,
start_month,
end_month,
time_granularity="MONTHLY",
main_domain_only=False):
"""
Parameters
----------
api_key: string
SimilarWeb API key
endpoint: string
Endpoint to use. Can be: pageviews, visitduration, bouncerate
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
time_granularity: string
Time granularity of report. Can be: Daily, Weekly, Monthly
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
"""
if endpoint not in ["pageviews", "visitduration", "bouncerate"]:
raise InvalidEndpointException(
"Endpoint must be one of the following values: "
"pageviews, visitduration, bouncerate")
self.endpoint = endpoint
self.domain = utils.domain_from_url(domain)
self.start_month = start_month
self.end_month = end_month
self.time_granularity = time_granularity
self.main_domain_only = main_domain_only
super(EngagementAPI, self).__init__(api_key)
def __init__(self, api_key, endpoint, domain, start_month, end_month,
main_domain_only=False, results_page=None):
"""
Parameters
----------
api_key: string
SimilarWeb API key
endpoint: string
Endpoint to use. Can be: orgkwcompetitor, paidkwcompetitor
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
results_page: integer
Enter for more than 10 results
"""
if endpoint not in ["orgkwcompetitor", "paidkwcompetitor", ]:
raise InvalidEndpointException("Endpoint must be one of the following values: "
"orgkwcompetitor, paidkwcompetitor")
self.domain = utils.domain_from_url(domain)
self.endpoint = endpoint
self.start_month = start_month
self.end_month = end_month
self.main_domain_only = main_domain_only
self.results_page = results_page
super(KeywordCompetitorsAPI, self).__init__(api_key)
def __init__(self, api_key, endpoint, domain, start_month, end_month,
time_granularity="MONTHLY", main_domain_only=False):
"""
Parameters
----------
api_key: string
SimilarWeb API key
endpoint: string
Endpoint to use. Can be: pageviews, visitduration, bouncerate
domain: string
Domain to query.
start_month: string
Start Month in (M-YYYY) format
end_month: string
End Month in (M-YYYY) format
time_granularity: string
Time granularity of report. Can be: Daily, Weekly, Monthly
main_domain_only: boolean
Get metrics on the Main Domain only (i.e. not including subdomains)
"""
if endpoint not in ["pageviews", "visitduration", "bouncerate"]:
raise InvalidEndpointException("Endpoint must be one of the following values: "
"pageviews, visitduration, bouncerate")
self.endpoint = endpoint
self.domain = utils.domain_from_url(domain)
self.start_month = start_month
self.end_month = end_month
self.time_granularity = time_granularity
self.main_domain_only = main_domain_only
super(EngagementAPI, self).__init__(api_key)
