GET api/Site?systemName={systemName}&username={username}&password={password}&publisherId={publisherId}&name={name}&comparison={comparison}&statistics={statistics}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all sites for publisher matching name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

publisherId

integer

Required

name

string

Required

comparison

string

Required

statistics

string

Default value is none

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 APISite
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

PublisherId

Unique identifier of publisher to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

Name

Textual identifier

string

None.

URL

URL of site

string

None.

MakeURLVisibleToThirdParty

Denotes that URL should be visible to third parties

boolean

None.

Language

Default accept language string for site

string

None.

ImpressionCount

Statistics impression count

integer

None.

ClickCount

Statistics click count

integer

None.

Spent

Statistics spent

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "publisherId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "url": "sample string 5",
    "makeURLVisibleToThirdParty": true,
    "language": "sample string 6",
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  },
  {
    "id": 1,
    "publisherId": 2,
    "state": "sample string 3",
    "name": "sample string 4",
    "url": "sample string 5",
    "makeURLVisibleToThirdParty": true,
    "language": "sample string 6",
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPISite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APISite>
    <ClickCount>1</ClickCount>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <Language>sample string 6</Language>
    <MakeURLVisibleToThirdParty>true</MakeURLVisibleToThirdParty>
    <Name>sample string 4</Name>
    <PublisherId>2</PublisherId>
    <Spent>1.1</Spent>
    <State>sample string 3</State>
    <URL>sample string 5</URL>
  </APISite>
  <APISite>
    <ClickCount>1</ClickCount>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <Language>sample string 6</Language>
    <MakeURLVisibleToThirdParty>true</MakeURLVisibleToThirdParty>
    <Name>sample string 4</Name>
    <PublisherId>2</PublisherId>
    <Spent>1.1</Spent>
    <State>sample string 3</State>
    <URL>sample string 5</URL>
  </APISite>
</ArrayOfAPISite>