GET api/Network?systemName={systemName}&username={username}&password={password}&networkGroupId={networkGroupId}&name={name}&comparison={comparison}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all networks for network group matching name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

networkGroupId

integer

Required

name

string

Required

comparison

string

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

includeClosed

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of APINetwork
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

NetworkGroupId

Unique identifier of network group to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

NetworkNumber

Automatically allocated numerical reference number

integer

None.

Name

Textual identifier

string

None.

Description

Longer description

string

None.

AllowKeywords

Allow usage of keywords in advert selection

boolean

None.

AllowSectors

Allow usage of sectors in advert selection

boolean

None.

AllowRunOfNetworks

Allow usage of automatic coverage in advert selection

boolean

None.

AllowAdUnits

Allow usage of ad units in advert selection

boolean

None.

AllowRetargeting

Allow usage of retargeting in advert selection

boolean

None.

AllowBeacons

Allow usage of beacons in advert selection

boolean

None.

PricingPerImpression

Allow charging based upon CPM model

boolean

None.

PricingPerClick

Allow charging based upon CPC model

boolean

None.

PricingPerEvent

Allow charging based upon CPA model

boolean

None.

EitherOrPricing

Allow charging on either CPM or CPC model if both are enabled

boolean

None.

MinimumImpressionPrice

The required CPM for an advert to appear

decimal number

None.

MinimumClickPrice

The required CPC for an advert to appear

decimal number

None.

ContraRevenuePercentage

Percentage adjustment for charges and refunds

decimal number

None.

IgnoreContraRevenuePercentage

Ignore percentage adjustment for charges and refunds

boolean

None.

SecondPriceAuction

Use second price auction to determine charged prices based upon bidding ladder

boolean

None.

PerformanceRanking

Use recent performance information in ranking of adverts

boolean

None.

ShuffleResults

Use shuffle algorithm to slightly re-arrange adverts

boolean

None.

ShuffleBlocksSeparately

Shuffle blocks separately so that favoured beacons and retargets maintain prioritisation

boolean

None.

FavourBeaconPercentage

Percentage of beacons to be favoured within results

decimal number

None.

FavourRetargetingPercentage

Percentage of retargets to be favoured within results

decimal number

None.

RandomisationPercentage

Percentage of searches to be randomly selected

decimal number

None.

MatchLogoSize

Force text and bullet adverts to precisely match logo size

boolean

None.

ClickFraudAlgorithm

Disabled, Guid, IpAddress, GuidAndIpAddress

string

None.

RefererMissingSearchFilter

Enabled, Disabled or Inherit

string

None.

UseragentMissingSearchFilter

Enabled, Disabled or Inherit

string

None.

IPIntelligenceSearchFilter

Enabled, Disabled or Inherit

string

None.

RefererMissingClickFilter

Enabled, Disabled or Inherit

string

None.

UseragentMissingClickFilter

Enabled, Disabled or Inherit

string

None.

RefererMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

UseragentMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

IPAddressMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

PartialIPAddressMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

CookiesNotEnabledClickFilter

Enabled, Disabled or Inherit

string

None.

ClickPositionMissingClickFilter

Enabled, Disabled or Inherit

string

None.

ClickPositionOffScreenClickFilter

Enabled, Disabled or Inherit

string

None.

AutomatedCrawlerClickFilter

Enabled, Disabled or Inherit

string

None.

WindowTooSmallClickFilter

Enabled, Disabled or Inherit

string

None.

MinimumWindowPercentage

Minimum window percentage for clicks

integer

None.

ConfidenceClickFilter

Enabled, Disabled or Inherit

string

None.

ConfidenceThreshold

Minimum confidence threshold for clicks

integer

None.

MaximumSearchToImpressionFilter

Enabled, Disabled or Inherit

string

None.

MaximumSearchToImpressionInterval

Maximum time in seconds between search and impression

integer

None.

MinimumSearchToClickFilter

Enabled, Disabled or Inherit

string

None.

MinimumSearchToClickInterval

Minimum time in seconds between search and click

integer

None.

MaximumSearchToClickFilter

Enabled, Disabled or Inherit

string

None.

MaximumSearchToClickInterval

Maximum time in seconds between search and click

integer

None.

MinimumClickToClickFilter

Enabled, Disabled or Inherit

string

None.

MinimumClickToClickInterval

Minimum time in seconds between clicks

integer

None.

MaximumSearchClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumSearchClicks

Maximum number of clicks per search

integer

None.

MaximumResultClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumResultClicks

Maximum number of clicks per result

integer

None.

MaximumAdvertClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumAdvertClicks

Maximum number of clicks per advert

integer

None.

MaximumOverallClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumOverallClicks

Maximum number of clicks overall

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "networkGroupId": 2,
    "state": "sample string 3",
    "networkNumber": 1,
    "name": "sample string 4",
    "description": "sample string 5",
    "allowKeywords": true,
    "allowSectors": true,
    "allowRunOfNetworks": true,
    "allowAdUnits": true,
    "allowRetargeting": true,
    "allowBeacons": true,
    "pricingPerImpression": true,
    "pricingPerClick": true,
    "pricingPerEvent": true,
    "eitherOrPricing": true,
    "minimumImpressionPrice": 1.1,
    "minimumClickPrice": 1.1,
    "contraRevenuePercentage": 1.1,
    "ignoreContraRevenuePercentage": true,
    "secondPriceAuction": true,
    "performanceRanking": true,
    "shuffleResults": true,
    "shuffleBlocksSeparately": true,
    "favourBeaconPercentage": 1.1,
    "favourRetargetingPercentage": 1.1,
    "randomisationPercentage": 1.1,
    "matchLogoSize": true,
    "clickFraudAlgorithm": "sample string 6",
    "refererMissingSearchFilter": "sample string 7",
    "useragentMissingSearchFilter": "sample string 8",
    "ipIntelligenceSearchFilter": "sample string 9",
    "refererMissingClickFilter": "sample string 10",
    "useragentMissingClickFilter": "sample string 11",
    "refererMismatchClickFilter": "sample string 12",
    "useragentMismatchClickFilter": "sample string 13",
    "ipAddressMismatchClickFilter": "sample string 14",
    "partialIPAddressMismatchClickFilter": "sample string 15",
    "cookiesNotEnabledClickFilter": "sample string 16",
    "clickPositionMissingClickFilter": "sample string 17",
    "clickPositionOffScreenClickFilter": "sample string 18",
    "automatedCrawlerClickFilter": "sample string 19",
    "windowTooSmallClickFilter": "sample string 20",
    "minimumWindowPercentage": 1,
    "confidenceClickFilter": "sample string 21",
    "confidenceThreshold": 1,
    "maximumSearchToImpressionFilter": "sample string 22",
    "maximumSearchToImpressionInterval": 1,
    "minimumSearchToClickFilter": "sample string 23",
    "minimumSearchToClickInterval": 1,
    "maximumSearchToClickFilter": "sample string 24",
    "maximumSearchToClickInterval": 1,
    "minimumClickToClickFilter": "sample string 25",
    "minimumClickToClickInterval": 1,
    "maximumSearchClicksFilter": "sample string 26",
    "maximumSearchClicks": 1,
    "maximumResultClicksFilter": "sample string 27",
    "maximumResultClicks": 1,
    "maximumAdvertClicksFilter": "sample string 28",
    "maximumAdvertClicks": 1,
    "maximumOverallClicksFilter": "sample string 29",
    "maximumOverallClicks": 1
  },
  {
    "id": 1,
    "networkGroupId": 2,
    "state": "sample string 3",
    "networkNumber": 1,
    "name": "sample string 4",
    "description": "sample string 5",
    "allowKeywords": true,
    "allowSectors": true,
    "allowRunOfNetworks": true,
    "allowAdUnits": true,
    "allowRetargeting": true,
    "allowBeacons": true,
    "pricingPerImpression": true,
    "pricingPerClick": true,
    "pricingPerEvent": true,
    "eitherOrPricing": true,
    "minimumImpressionPrice": 1.1,
    "minimumClickPrice": 1.1,
    "contraRevenuePercentage": 1.1,
    "ignoreContraRevenuePercentage": true,
    "secondPriceAuction": true,
    "performanceRanking": true,
    "shuffleResults": true,
    "shuffleBlocksSeparately": true,
    "favourBeaconPercentage": 1.1,
    "favourRetargetingPercentage": 1.1,
    "randomisationPercentage": 1.1,
    "matchLogoSize": true,
    "clickFraudAlgorithm": "sample string 6",
    "refererMissingSearchFilter": "sample string 7",
    "useragentMissingSearchFilter": "sample string 8",
    "ipIntelligenceSearchFilter": "sample string 9",
    "refererMissingClickFilter": "sample string 10",
    "useragentMissingClickFilter": "sample string 11",
    "refererMismatchClickFilter": "sample string 12",
    "useragentMismatchClickFilter": "sample string 13",
    "ipAddressMismatchClickFilter": "sample string 14",
    "partialIPAddressMismatchClickFilter": "sample string 15",
    "cookiesNotEnabledClickFilter": "sample string 16",
    "clickPositionMissingClickFilter": "sample string 17",
    "clickPositionOffScreenClickFilter": "sample string 18",
    "automatedCrawlerClickFilter": "sample string 19",
    "windowTooSmallClickFilter": "sample string 20",
    "minimumWindowPercentage": 1,
    "confidenceClickFilter": "sample string 21",
    "confidenceThreshold": 1,
    "maximumSearchToImpressionFilter": "sample string 22",
    "maximumSearchToImpressionInterval": 1,
    "minimumSearchToClickFilter": "sample string 23",
    "minimumSearchToClickInterval": 1,
    "maximumSearchToClickFilter": "sample string 24",
    "maximumSearchToClickInterval": 1,
    "minimumClickToClickFilter": "sample string 25",
    "minimumClickToClickInterval": 1,
    "maximumSearchClicksFilter": "sample string 26",
    "maximumSearchClicks": 1,
    "maximumResultClicksFilter": "sample string 27",
    "maximumResultClicks": 1,
    "maximumAdvertClicksFilter": "sample string 28",
    "maximumAdvertClicks": 1,
    "maximumOverallClicksFilter": "sample string 29",
    "maximumOverallClicks": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPINetwork xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APINetwork>
    <AllowAdUnits>true</AllowAdUnits>
    <AllowBeacons>true</AllowBeacons>
    <AllowKeywords>true</AllowKeywords>
    <AllowRetargeting>true</AllowRetargeting>
    <AllowRunOfNetworks>true</AllowRunOfNetworks>
    <AllowSectors>true</AllowSectors>
    <AutomatedCrawlerClickFilter>sample string 19</AutomatedCrawlerClickFilter>
    <ClickFraudAlgorithm>sample string 6</ClickFraudAlgorithm>
    <ClickPositionMissingClickFilter>sample string 17</ClickPositionMissingClickFilter>
    <ClickPositionOffScreenClickFilter>sample string 18</ClickPositionOffScreenClickFilter>
    <ConfidenceClickFilter>sample string 21</ConfidenceClickFilter>
    <ConfidenceThreshold>1</ConfidenceThreshold>
    <ContraRevenuePercentage>1.1</ContraRevenuePercentage>
    <CookiesNotEnabledClickFilter>sample string 16</CookiesNotEnabledClickFilter>
    <Description>sample string 5</Description>
    <EitherOrPricing>true</EitherOrPricing>
    <FavourBeaconPercentage>1.1</FavourBeaconPercentage>
    <FavourRetargetingPercentage>1.1</FavourRetargetingPercentage>
    <IPAddressMismatchClickFilter>sample string 14</IPAddressMismatchClickFilter>
    <IPIntelligenceSearchFilter>sample string 9</IPIntelligenceSearchFilter>
    <Id>1</Id>
    <IgnoreContraRevenuePercentage>true</IgnoreContraRevenuePercentage>
    <MatchLogoSize>true</MatchLogoSize>
    <MaximumAdvertClicks>1</MaximumAdvertClicks>
    <MaximumAdvertClicksFilter>sample string 28</MaximumAdvertClicksFilter>
    <MaximumOverallClicks>1</MaximumOverallClicks>
    <MaximumOverallClicksFilter>sample string 29</MaximumOverallClicksFilter>
    <MaximumResultClicks>1</MaximumResultClicks>
    <MaximumResultClicksFilter>sample string 27</MaximumResultClicksFilter>
    <MaximumSearchClicks>1</MaximumSearchClicks>
    <MaximumSearchClicksFilter>sample string 26</MaximumSearchClicksFilter>
    <MaximumSearchToClickFilter>sample string 24</MaximumSearchToClickFilter>
    <MaximumSearchToClickInterval>1</MaximumSearchToClickInterval>
    <MaximumSearchToImpressionFilter>sample string 22</MaximumSearchToImpressionFilter>
    <MaximumSearchToImpressionInterval>1</MaximumSearchToImpressionInterval>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumClickToClickFilter>sample string 25</MinimumClickToClickFilter>
    <MinimumClickToClickInterval>1</MinimumClickToClickInterval>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <MinimumSearchToClickFilter>sample string 23</MinimumSearchToClickFilter>
    <MinimumSearchToClickInterval>1</MinimumSearchToClickInterval>
    <MinimumWindowPercentage>1</MinimumWindowPercentage>
    <Name>sample string 4</Name>
    <NetworkGroupId>2</NetworkGroupId>
    <NetworkNumber>1</NetworkNumber>
    <PartialIPAddressMismatchClickFilter>sample string 15</PartialIPAddressMismatchClickFilter>
    <PerformanceRanking>true</PerformanceRanking>
    <PricingPerClick>true</PricingPerClick>
    <PricingPerEvent>true</PricingPerEvent>
    <PricingPerImpression>true</PricingPerImpression>
    <RandomisationPercentage>1.1</RandomisationPercentage>
    <RefererMismatchClickFilter>sample string 12</RefererMismatchClickFilter>
    <RefererMissingClickFilter>sample string 10</RefererMissingClickFilter>
    <RefererMissingSearchFilter>sample string 7</RefererMissingSearchFilter>
    <SecondPriceAuction>true</SecondPriceAuction>
    <ShuffleBlocksSeparately>true</ShuffleBlocksSeparately>
    <ShuffleResults>true</ShuffleResults>
    <State>sample string 3</State>
    <UseragentMismatchClickFilter>sample string 13</UseragentMismatchClickFilter>
    <UseragentMissingClickFilter>sample string 11</UseragentMissingClickFilter>
    <UseragentMissingSearchFilter>sample string 8</UseragentMissingSearchFilter>
    <WindowTooSmallClickFilter>sample string 20</WindowTooSmallClickFilter>
  </APINetwork>
  <APINetwork>
    <AllowAdUnits>true</AllowAdUnits>
    <AllowBeacons>true</AllowBeacons>
    <AllowKeywords>true</AllowKeywords>
    <AllowRetargeting>true</AllowRetargeting>
    <AllowRunOfNetworks>true</AllowRunOfNetworks>
    <AllowSectors>true</AllowSectors>
    <AutomatedCrawlerClickFilter>sample string 19</AutomatedCrawlerClickFilter>
    <ClickFraudAlgorithm>sample string 6</ClickFraudAlgorithm>
    <ClickPositionMissingClickFilter>sample string 17</ClickPositionMissingClickFilter>
    <ClickPositionOffScreenClickFilter>sample string 18</ClickPositionOffScreenClickFilter>
    <ConfidenceClickFilter>sample string 21</ConfidenceClickFilter>
    <ConfidenceThreshold>1</ConfidenceThreshold>
    <ContraRevenuePercentage>1.1</ContraRevenuePercentage>
    <CookiesNotEnabledClickFilter>sample string 16</CookiesNotEnabledClickFilter>
    <Description>sample string 5</Description>
    <EitherOrPricing>true</EitherOrPricing>
    <FavourBeaconPercentage>1.1</FavourBeaconPercentage>
    <FavourRetargetingPercentage>1.1</FavourRetargetingPercentage>
    <IPAddressMismatchClickFilter>sample string 14</IPAddressMismatchClickFilter>
    <IPIntelligenceSearchFilter>sample string 9</IPIntelligenceSearchFilter>
    <Id>1</Id>
    <IgnoreContraRevenuePercentage>true</IgnoreContraRevenuePercentage>
    <MatchLogoSize>true</MatchLogoSize>
    <MaximumAdvertClicks>1</MaximumAdvertClicks>
    <MaximumAdvertClicksFilter>sample string 28</MaximumAdvertClicksFilter>
    <MaximumOverallClicks>1</MaximumOverallClicks>
    <MaximumOverallClicksFilter>sample string 29</MaximumOverallClicksFilter>
    <MaximumResultClicks>1</MaximumResultClicks>
    <MaximumResultClicksFilter>sample string 27</MaximumResultClicksFilter>
    <MaximumSearchClicks>1</MaximumSearchClicks>
    <MaximumSearchClicksFilter>sample string 26</MaximumSearchClicksFilter>
    <MaximumSearchToClickFilter>sample string 24</MaximumSearchToClickFilter>
    <MaximumSearchToClickInterval>1</MaximumSearchToClickInterval>
    <MaximumSearchToImpressionFilter>sample string 22</MaximumSearchToImpressionFilter>
    <MaximumSearchToImpressionInterval>1</MaximumSearchToImpressionInterval>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumClickToClickFilter>sample string 25</MinimumClickToClickFilter>
    <MinimumClickToClickInterval>1</MinimumClickToClickInterval>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <MinimumSearchToClickFilter>sample string 23</MinimumSearchToClickFilter>
    <MinimumSearchToClickInterval>1</MinimumSearchToClickInterval>
    <MinimumWindowPercentage>1</MinimumWindowPercentage>
    <Name>sample string 4</Name>
    <NetworkGroupId>2</NetworkGroupId>
    <NetworkNumber>1</NetworkNumber>
    <PartialIPAddressMismatchClickFilter>sample string 15</PartialIPAddressMismatchClickFilter>
    <PerformanceRanking>true</PerformanceRanking>
    <PricingPerClick>true</PricingPerClick>
    <PricingPerEvent>true</PricingPerEvent>
    <PricingPerImpression>true</PricingPerImpression>
    <RandomisationPercentage>1.1</RandomisationPercentage>
    <RefererMismatchClickFilter>sample string 12</RefererMismatchClickFilter>
    <RefererMissingClickFilter>sample string 10</RefererMissingClickFilter>
    <RefererMissingSearchFilter>sample string 7</RefererMissingSearchFilter>
    <SecondPriceAuction>true</SecondPriceAuction>
    <ShuffleBlocksSeparately>true</ShuffleBlocksSeparately>
    <ShuffleResults>true</ShuffleResults>
    <State>sample string 3</State>
    <UseragentMismatchClickFilter>sample string 13</UseragentMismatchClickFilter>
    <UseragentMissingClickFilter>sample string 11</UseragentMissingClickFilter>
    <UseragentMissingSearchFilter>sample string 8</UseragentMissingSearchFilter>
    <WindowTooSmallClickFilter>sample string 20</WindowTooSmallClickFilter>
  </APINetwork>
</ArrayOfAPINetwork>