competitivetracker.overlaps

class competitivetracker.overlaps.Overlaps(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)
get_domain_overlaps(domain, **kwargs)

Determines the overlap for a domain given the filters specified.

Parameters

  • domain (str) – (Required) The domain to use in the request

  • minThreshold (int) –

    Minimum overlap percentage to use

    Defaults to 10

  • maxResults (int) –

    Maximum Results to return

    Defaults to 100

  • ignoreIndustry (bool) –

    If you wish to ignore the industry filter and return all overlaps

    Defaults to False

  • excludeSameCompany (bool) –

    If you wish to exclude domains that are under the same company

    Defaults to False

  • embed (str) –

    The objects within the return model you wish to embed in the form of ‘customer, customer.name, etc’

    Accepts: readRatePercent, projectedReach

Returns

A dict containing overlap details.

get_narrowed_overlap(domain, **kwargs)

Determines the overlap for a domain against a specific set and include attributes about the overlap.

Parameters

  • domain (str) – (Required) The domain to use in the request

  • overlapDomain – (Required) List of strings. The other domains to analyze overlap with (multiple params accepted)

Returns

A dict containing overlap details.

get_top_competing(domain, **kwargs)

Determines the top competing domains and returns their overlaps.

Parameters

  • domain (str) – (Required) The domain to use in the request

  • minThreshold (int) –

    Minimum overlap percentage to use

    Defaults to 10

  • maxResults (int) –

    Maximum Results to return

    Defaults to 100

  • embed (str) –

    The objects within the return model you wish to embed in the form of ‘customer, customer.name, etc’

    Accepts: readRatePercent, projectedReach

Returns

A dict containing overlap details