`competitivetracker.core.brands`

class competitivetracker.core.Brands(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

get_all_brand_domains(brandId, **kwargs)

All the domains associated with the brand.

Parameters

brandId (int) – The id of the brand
page (int) – The page to query for in pagination
per_page (int) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name

Returns

A list of object dict containing matching results, with name and id

get_all_brands(**kwargs)

Returns all of the brands (paged).

Parameters

page (int) – The page to query for in pagination
per_page (int) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name
embed (str) –
The objects within the return model you wish to embed in the form of ‘customer, customer.name, etc’

Accepts: address, company, industry

Returns

A list of object dict containing name and id of all brands

get_brand_details(brandId, **kwargs)

Get a distinct brand by its id.

Parameters: brandId (int) – The id of the brand
Returns: A dict containing name and id

`competitivetracker.core.companies`

class competitivetracker.core.Companies(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

get_all_companies(**kwargs)

Returns all of the companies (paged).

Parameters

page (int) – The page to query for in pagination
per_page (int) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name
embed (str) –
The objects within the return model you wish to embed in the form of ‘customer, customer.name, etc’

Accepts: address, company, industry

Returns

A list of object dict containing name and id of all companies

get_all_company_brands(companyId, **kwargs)

All the brands associated with the company.

Parameters

companyId (int) – The id of the company
page (int) – The page to query for in pagination
per_page (int) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name

Returns

A list of object dict containing matching results, with name and id

get_company_details(companyId, **kwargs)

Get a distinct company by its id.

Parameters: companyId (int) – The id of the company
Returns: A dict containing name and id

`competitivetracker.core.discover`

class competitivetracker.core.Discover(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

search(**kwargs)

Search in all the core types for a matching string (max 1000 results).

Parameters: q (str) – Query parameter to match. String to search for.
Returns: A dict containing name and id of search results

search_brands(**kwargs)

Search in brands for a matching string (max 1000 results).

Parameters: q (str) – Query parameter to match. String to search for.
Returns: A dict containing name and id of search results

search_companies(**kwargs)

Search in companies for a matching string (max 1000 results).

Parameters: q (str) – Query parameter to match. String to search for.
Returns: A dict containing name and id of search results

search_domains(**kwargs)

Search in domains for a matching string (max 1000 results).

Parameters: q (str) – Query parameter to match. String to search for.
Returns: A dict containing name and id of search results

search_esps(**kwargs)

Search ESPs for a matching string (max 1000 results).

Parameters: q (str) – Query parameter to match. String to search for.
Returns: A dict containing name and id of search results

search_industries(**kwargs)

Search in industries for a matching string (max 1000 results).

Parameters: q (str) – Query parameter to match. String to search for.
Returns: A dict containing name and id of search results

`competitivetracker.core.domains`

class competitivetracker.core.Domains(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

get_all_domains(**kwargs)

Returns all of the domains (paged).

Parameters

page (str) – The page to query for in pagination
per_page (str) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name

Returns

A list of object dict containing name and id of all companies

get_domain_details(domainId, **kwargs)

Get a distinct domain by its id.

Parameters

domainId (int) – The id of the domain
embed (str) –
The objects within the return model you wish to embed in the form of ‘customer,customer.name,etc’

Accepts: brands, brands.address, brands.company, brands.industry

Returns

A dict containing name and id

`competitivetracker.core.esps`

class competitivetracker.core.Esps(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

get_all_esps(**kwargs)

Returns all of the email service providers ordered by name (paged).

Parameters

page (int) – The page to query for in pagination
per_page (int) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name

Returns

A list of object dict containing name and id of all esps

get_esp_details(espId, **kwargs)

Get a distinct ESP by its ID.

Parameters: espId (int) – The ID of the ESP
Returns: A dict containing name and id

`competitivetracker.core.graph`

class competitivetracker.core.Graph(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

get_company(**kwargs)

Get the company graphs by searching for company names.

Parameters: q (str) – The string to search with (at least 3 characters)
Returns: A list of object dict containing company details

get_company_from_domain(domainName, **kwargs)

Get the company the domain belongs to and display the graph.

Parameters: domainName (str) – The name of the domain under the company.
Returns: A dict containing company details

get_company_from_id(companyId, **kwargs)

Get the company graph for a distinct company by its id.

Parameters: companyId (int) – The id of the company
Returns: A dict containing company details

`competitivetracker.core.industries`

class competitivetracker.core.Industries(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

get_all_industries(**kwargs)

Returns all of the industries ordered by name (paged).

Parameters

page (int) – The page to query for in pagination
per_page (int) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name

Returns

A list of object dict containing name and id of all industries

get_all_industry_brands(industryId, **kwargs)

All the brands associated with an industry.

Parameters

industryId (int) – The id of the industry
page (int) – The page to query for in pagination
per_page (int) – The amount of records per page you wish to query for (max 100)
order (str) –
The property to sort by (‘property’ for descending, ‘-property’ for ascending)

Accepts: name, -name

Returns

A list of object dict containing matching results, with name and id

get_industry_details(industryId, **kwargs)

Get a distinct industry by its id.

Parameters: industryId (int) – The id of the industry
Returns: A dict containing name and id

`competitivetracker.core.ping`

class competitivetracker.core.Ping(base_uri, api_key, transport_class=<class 'competitivetracker.base.RequestsTransport'>)

ping_service()

Ping the service to verify it is reachable.

Returns: A str object. A successful ping will return the string ‘pong’.

competitivetracker.core.brands

competitivetracker.core.companies

competitivetracker.core.discover

competitivetracker.core.domains

competitivetracker.core.esps

competitivetracker.core.graph

competitivetracker.core.industries

competitivetracker.core.ping

`competitivetracker.core.brands`

`competitivetracker.core.companies`

`competitivetracker.core.discover`

`competitivetracker.core.domains`

`competitivetracker.core.esps`

`competitivetracker.core.graph`

`competitivetracker.core.industries`

`competitivetracker.core.ping`