Common Account Data

Client Methods

class performline.products.common.api.CommonClientMethods

Methods for retrieving data common to all products.

brands(id=None, limit=None, offset=None, create_date=None)

Retrieve one or more brands associated with an account.

Parameters:id (int, optional) – If specified, retrieve a single brand by the given ID. Otherwise, return all brands. Returns:An instance of Brand if id is not None representing the brand with that ID. Otherwise, retrieve a list of Brand instances of all brands associated with the account. Raises:See request()

campaigns(id=None, limit=None, offset=None, brand=None)

Retrieve one or more campaigns associated with an account.

Parameters:id (int, optional) – If specified, retrieve a single campaign by the given ID. Otherwise, return all campaigns. Returns:An instance of Campaign if id is not None representing the campaign with that ID. Otherwise, retrieve a list of Campaign instances of all campaigns associated with the account. Raises:See request()

items(id=None, limit=None, offset=None, brand=None, campaign=None)

Retrieve one or more scorable items associated with an account.

Parameters:id (int, optional) – If specified, retrieve a single item by the given ID. Otherwise, return all items. Returns:An instance of Item if id is not None representing the item with that ID. Otherwise, retrieve a list of Item instances of all items associated with the account. Raises:See request()

remediation_statuses()

Retrieve all available remediation statuses available in the Performline platform. :returns: An instance of RemediationStatuses,

which has a property returning a list of strings representing the availa

return RemediationStatus.get()

rules(id=None, limit=None, offset=None)

Retrieve one or more rules associated with an account.

Parameters:id (int, optional) – If specified, retrieve a single rule by the given ID. Otherwise, return all rules. Returns:An instance of Rule if id is not None representing the rule with that ID. Otherwise, retrieve a list of Rule instances of all rules associated with the account. Raises:See request()

trafficsources(id=None, limit=None, offset=None)

Retrieve one or more traffic sources associated with an account.

Parameters:id (int, optional) – If specified, retrieve a single traffic source by the given ID. Otherwise, return all traffic sources. Returns:An instance of TrafficSource if id is not None representing the traffic source with that ID. Otherwise, retrieve a list of TrafficSource instances of all traffic sources associated with the account. Raises:See request()

Data Access Models

Models representing common API objects

class performline.products.common.models.Brand(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving data from and working with an individual brand.

class performline.products.common.models.BrandRules(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving data rules for a specific brand.

class performline.products.common.models.Campaign(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving data from and working with an individual campaign.

class performline.products.common.models.CampaignRules(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving data rules for a specific campaign.

class performline.products.common.models.Item(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving data from and working with scorable content, regardless of product.

class performline.products.common.models.RemediationStatus(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving all available remediation statuses in the platform.

class performline.products.common.models.Rule(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving data from and working with an individual rule.

class performline.products.common.models.TrafficSource(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)

An object for retrieving data from and working with an individual traffic source.

class performline.products.common.models.Workflow(client, data=None, metadata={}, rest_root=None, primary_key=None, secondary_key=None)