POST api/Template?systemName={systemName}&username={username}&password={password}

Creates a new report template

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

Body Parameters

APIReportDefinition
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

LoginType

Type of login for which this definition is intended: Agency, Advertiser, Consortium, Publisher, Network, NetworkGroup or System (Templates only)

string

None.

Language

Language to be used to generate report: English, French, German or Italian

string

None.

Immediate

Denotes that report is pending (Reports only)

boolean

None.

Frequency

Frequency of report update: Once, Hourly, Daily, Weekly, Monthly or Quarterly

string

None.

HoursToDelay

Number of hour to defer report generation (Reports only)

integer

None.

Suspended

Denotes that report has been suspended (Reports only)

boolean

None.

Email

Denotes that report should be sent by email (Reports only)

boolean

None.

FirstName

First name of email recipient (Reports only)

string

None.

Surname

Surname of email recipient (Reports only)

string

None.

EmailAddress

Address of email recipient (Reports only)

string

None.

Status

Queued, Processing, Ready, Error or Suspended (Reports only)

string

None.

Error

Short error message returned from report generation (Reports only)

string

None.

Title

Title of report (Templates and Reports - included in actual report)

string

None.

Folder

Name of folder to contain report

string

None.

Private

Denotes that report is private (Reports only)

boolean

None.

Description

Description of report (Templates only - not included in actual report)

string

None.

Timezone

Name of timezone from APITimezone

string

None.

DataSource

Leave blank

string

None.

CurrencySource

Leave blank

string

None.

LabelSource

Leave blank

string

None.

Currency

Currency to be used in report: GBP, USD, EUR, INR or TRY

string

None.

DateRange

Range of dates to be included: SpecificDate, SpecificDateRange, Today, Yesterday, ThisWeek, ThisMonth, ThisQuarter, LastWeek, LastMonth, LastQuarter, Last1Days, Last2Days, Last3Days, Last4Days, Last5Days, Last6Days, Last7Days, Last14Days, Last21Days or Last28Days

string

None.

IncludingToday

Denotes that relative date range should include today

boolean

None.

FirstDayOfWeek

Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday

string

None.

DateSplit

Type of split to be applied to dates: NoSplit, Hourly, Daily, Weekly or Monthly

string

None.

UntotalledDateSplit

Denotes that default date split should not be totalled

boolean

None.

DateComparison

Denotes “standard” (no comparison) or “comparison” type report: NoComparison, SpecificDate, SpecificDateRange, DayBefore, WeekBefore, MonthBefore, QuarterBefore, Preceding1Days, Preceding2Days, Preceding3Days, Preceding4Days, Preceding5Days, Preceding6Days, Preceding7Days, Preceding14Days, Preceding21Days or Preceding28Days

string

None.

SpecificDate

For reports where the DateRange is SpecificDate, this field contains the date in DD-MM-YYYY format

string

None.

SpecificDateRangeFrom

For reports where the DateRange is SpecificDateRange, this field contains the start date in DD-MM-YYYY format

string

None.

SpecificDateRangeTo

For reports where the DateRange is SpecificDateRange, this field contains the end date in DD-MM-YYYY format

string

None.

SpecificComparisonDate

For comparison reports where the DateComparison is SpecificDate, this field contains the comparitive date in DD-MM-YYYY format

string

None.

SpecificComparisonDateRangeFrom

For comparison reports where the DateComparison is SpecificDateRange, this field contains the comparitive start date in DD-MM-YYYY format

string

None.

SpecificComparisonDateRangeTo

For comparison reports where the DateComparison is SpecificDateRange, this field contains the comparitive end date in DD-MM-YYYY format

string

None.

SubPublisherComparison

Denotes that the report should only include a subset of all subpublishers: NoComparison, Containing, NotContaining, Starting, NotStarting, Matching or NotMatching

string

None.

SubPublisher

For reports including only a subset of subpublishers, this field contains the comparitive string

string

None.

ClickUrlComparison

Denotes that the report should include only a subset of click urls: NoComparison, Containing, NotContaining, Starting, NotStarting, Matching or NotMatching

string

None.

ClickUrl

For reports containing only a subset of click urls, this field contains the comparitive string

string

None.

RefererComparison

Denotes that the report should include only a subset of referers: NoComparison, Containing, NotContaining, Starting, NotStarting, Matching or NotMatching

string

None.

Referer

For reports containing only a subset of referers, this field contains the comparitive string

string

None.

UseragentComparison

Denotes that the report should include only a subset of useragents: NoComparison, Containing, NotContaining, Starting, NotStarting, Matching or NotMatching

string

None.

Useragent

For reports containing only a subset of useragents, this field contains the comparitive string

string

None.

IpAddressComparison

Denotes that the report should include only a subset of ip addresses: NoComparison, Containing, NotContaining, Starting, NotStarting, Matching or NotMatching

string

None.

IpAddress

For reports containing only a subset of ip addresses, this field contains the comparitive string

string

None.

ProviderId

List of unique identifiers of providers to be included in this report. If not specified, all providers will be included

Collection of integer

None.

NotProvider

Denotes that list of providers should be treated as an exclusion rather than an inclusion list

boolean

None.

AdvertiserId

List of unique identifiers of advertisers to be included in this report. If not specified, all advertisers will be included

Collection of integer

None.

NotAdvertiser

Denotes that list of advertisers should be treated as an exclusion rather than an inclusion list

boolean

None.

CampaignId

List of unique identifiers of campaigns to be included in this report. If not specified, all campaigns will be included

Collection of integer

None.

NotCampaign

Denotes that list of campaigns should be treated as an exclusion rather than an inclusion list

boolean

None.

BidId

List of unique identifiers of bids to be included in this report. If not specified, all bids will be included

Collection of integer

None.

NotBid

Denotes that list of bids should be treated as an exclusion rather than an inclusion list

boolean

None.

PublisherId

List of unique identifiers of publishers to be included in this report. If not specified, all publishers will be included

Collection of integer

None.

NotPublisher

Denotes that list of publishers should be treated as an exclusion rather than an inclusion list

boolean

None.

NetworkId

List of unique identifiers of networks to be included in this report. If not specified, all networks will be included

Collection of integer

None.

NotNetwork

Denotes that list of networks should be treated as an exclusion rather than an inclusion list

boolean

None.

LocationId

List of unique identifiers of locations to be included in this report. If not specified, all locations will be included

Collection of integer

None.

NotLocation

Denotes that list of locations should be treated as an exclusion rather than an inclusion list

boolean

None.

Table

List of APIReportDefinitionTable

Collection of APIReportDefinitionTable

None.

Field

List of either standard or comparative field names. If DateComparison is NoComparison, only standard field names may be included. Otherwise only comparison field names may be included. Field names must be the Name (not DisplayName) from APIReportDictionaryFieldDisplay

Collection of string

None.

CreationTimestamp

Timestamp when the report definition was originally created (Reports only)

string

None.

OriginalTemplateId

Id of original template from which this report was created (Reports only)

integer

None.

ProcessTimestamp

Timestamp when the report was last processed (Reports only)

string

None.

ProcessDuration

Number of seconds to process report (Reports only)

integer

None.

NumberOfRows

Number of rows in processed report (Reports only)

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "loginType": "sample string 2",
  "language": "sample string 3",
  "immediate": true,
  "frequency": "sample string 4",
  "hoursToDelay": 1,
  "suspended": true,
  "email": true,
  "firstName": "sample string 5",
  "surname": "sample string 6",
  "emailAddress": "sample string 7",
  "status": "sample string 8",
  "error": "sample string 9",
  "title": "sample string 10",
  "folder": "sample string 11",
  "private": true,
  "description": "sample string 12",
  "timezone": "sample string 13",
  "dataSource": "sample string 14",
  "currencySource": "sample string 15",
  "labelSource": "sample string 16",
  "currency": "sample string 17",
  "dateRange": "sample string 18",
  "includingToday": true,
  "firstDayOfWeek": "sample string 19",
  "dateSplit": "sample string 20",
  "untotalledDateSplit": true,
  "dateComparison": "sample string 21",
  "specificDate": "sample string 22",
  "specificDateRangeFrom": "sample string 23",
  "specificDateRangeTo": "sample string 24",
  "specificComparisonDate": "sample string 25",
  "specificComparisonDateRangeFrom": "sample string 26",
  "specificComparisonDateRangeTo": "sample string 27",
  "subPublisherComparison": "sample string 28",
  "subPublisher": "sample string 29",
  "clickUrlComparison": "sample string 30",
  "clickUrl": "sample string 31",
  "refererComparison": "sample string 32",
  "referer": "sample string 33",
  "useragentComparison": "sample string 34",
  "useragent": "sample string 35",
  "ipAddressComparison": "sample string 36",
  "ipAddress": "sample string 37",
  "providerId": [
    1,
    2
  ],
  "notProvider": true,
  "advertiserId": [
    1,
    2
  ],
  "notAdvertiser": true,
  "campaignId": [
    1,
    2
  ],
  "notCampaign": true,
  "bidId": [
    1,
    2
  ],
  "notBid": true,
  "publisherId": [
    1,
    2
  ],
  "notPublisher": true,
  "networkId": [
    1,
    2
  ],
  "notNetwork": true,
  "locationId": [
    1,
    2
  ],
  "notLocation": true,
  "table": [
    {
      "suppressTotal": true,
      "name": "sample string 1",
      "sortOrder": "sample string 2",
      "sortField": "sample string 3",
      "field": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "suppressTotal": true,
      "name": "sample string 1",
      "sortOrder": "sample string 2",
      "sortField": "sample string 3",
      "field": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "field": [
    "sample string 1",
    "sample string 2"
  ],
  "creationTimestamp": "sample string 38",
  "originalTemplateId": 39,
  "processTimestamp": "sample string 40",
  "processDuration": 41,
  "numberOfRows": 42
}

application/xml, text/xml

Sample:
<APIReportDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <AdvertiserId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </AdvertiserId>
  <BidId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BidId>
  <CampaignId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CampaignId>
  <ClickUrl>sample string 31</ClickUrl>
  <ClickUrlComparison>sample string 30</ClickUrlComparison>
  <CreationTimestamp>sample string 38</CreationTimestamp>
  <Currency>sample string 17</Currency>
  <CurrencySource>sample string 15</CurrencySource>
  <DataSource>sample string 14</DataSource>
  <DateComparison>sample string 21</DateComparison>
  <DateRange>sample string 18</DateRange>
  <DateSplit>sample string 20</DateSplit>
  <Description>sample string 12</Description>
  <Email>true</Email>
  <EmailAddress>sample string 7</EmailAddress>
  <Error>sample string 9</Error>
  <Field xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Field>
  <FirstDayOfWeek>sample string 19</FirstDayOfWeek>
  <FirstName>sample string 5</FirstName>
  <Folder>sample string 11</Folder>
  <Frequency>sample string 4</Frequency>
  <HoursToDelay>1</HoursToDelay>
  <Id>1</Id>
  <Immediate>true</Immediate>
  <IncludingToday>true</IncludingToday>
  <IpAddress>sample string 37</IpAddress>
  <IpAddressComparison>sample string 36</IpAddressComparison>
  <LabelSource>sample string 16</LabelSource>
  <Language>sample string 3</Language>
  <LocationId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LocationId>
  <LoginType>sample string 2</LoginType>
  <NetworkId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </NetworkId>
  <NotAdvertiser>true</NotAdvertiser>
  <NotBid>true</NotBid>
  <NotCampaign>true</NotCampaign>
  <NotLocation>true</NotLocation>
  <NotNetwork>true</NotNetwork>
  <NotProvider>true</NotProvider>
  <NotPublisher>true</NotPublisher>
  <NumberOfRows>42</NumberOfRows>
  <OriginalTemplateId>39</OriginalTemplateId>
  <Private>true</Private>
  <ProcessDuration>41</ProcessDuration>
  <ProcessTimestamp>sample string 40</ProcessTimestamp>
  <ProviderId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ProviderId>
  <PublisherId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PublisherId>
  <Referer>sample string 33</Referer>
  <RefererComparison>sample string 32</RefererComparison>
  <SpecificComparisonDate>sample string 25</SpecificComparisonDate>
  <SpecificComparisonDateRangeFrom>sample string 26</SpecificComparisonDateRangeFrom>
  <SpecificComparisonDateRangeTo>sample string 27</SpecificComparisonDateRangeTo>
  <SpecificDate>sample string 22</SpecificDate>
  <SpecificDateRangeFrom>sample string 23</SpecificDateRangeFrom>
  <SpecificDateRangeTo>sample string 24</SpecificDateRangeTo>
  <Status>sample string 8</Status>
  <SubPublisher>sample string 29</SubPublisher>
  <SubPublisherComparison>sample string 28</SubPublisherComparison>
  <Surname>sample string 6</Surname>
  <Suspended>true</Suspended>
  <Table>
    <APIReportDefinitionTable>
      <Field xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Field>
      <Name>sample string 1</Name>
      <SortField>sample string 3</SortField>
      <SortOrder>sample string 2</SortOrder>
      <SuppressTotal>true</SuppressTotal>
    </APIReportDefinitionTable>
    <APIReportDefinitionTable>
      <Field xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Field>
      <Name>sample string 1</Name>
      <SortField>sample string 3</SortField>
      <SortOrder>sample string 2</SortOrder>
      <SuppressTotal>true</SuppressTotal>
    </APIReportDefinitionTable>
  </Table>
  <Timezone>sample string 13</Timezone>
  <Title>sample string 10</Title>
  <UntotalledDateSplit>true</UntotalledDateSplit>
  <Useragent>sample string 35</Useragent>
  <UseragentComparison>sample string 34</UseragentComparison>
</APIReportDefinition>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>