PUT api/FeedReport?sessionId={sessionId}

Updates an existing feed report

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

Body Parameters

APIFeedReportDefinition
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

FeedId

Unique identifier of feed to which this belongs

integer

None.

Enabled

Denotes that feed report should be actively downloaded

boolean

None.

NextTimestampToFetch

Timestamp of next hour to be downloaded

string

None.

NumberOfHoursToDelay

Number of hours after start of day to delay download

integer

None.

FeedReportUrl

Url to be used for download

string

None.

Format

Format: CSV or XML

string

None.

ColumnDelimiter

Column delimiter which is normally "," but may also be "cr" (for carriage return), "lf" (for line feed), "space" or "tab"

string

None.

RowDelimiter

Row delimiter which is normally "lf" (for line feed) but may also be "cr" (for carriage return), "space" or "tab"

string

None.

Currency

Download data currency: GBP, USD, EUR, INR or TRY

string

None.

CurrencyScalar

Should be set to 1000

integer

None.

ImplicitPublisherId

Not normally used unless download relates to only one specific publisher id

integer

None.

PublisherNumberDescriptor

Descriptor of field containing publisher number

string

None.

PublisherNumberPrefixDelimiter

Delimiter marking prefix before publisher number

string

None.

PublisherNumberSuffixDelimiter

Delimiter marking suffix after publisher number

string

None.

SubPublisherDescriptor

Descriptor of field contain sub publisher identifier

string

None.

SubPublisherPrefixDelimiter

Delimiter marking prefix before sub publisher identifier

string

None.

ProviderSearchCountDescriptor

Descriptor of field containing search count

string

None.

ImpressionCountDescriptor

Descriptor of field containing impression count

string

None.

ImpressionGrossSpendDescriptor

Descriptor of field containing gross impression spend

string

None.

ImpressionGrossSpendDiscountPercentage

Percentage discount to be applied to gross impression spend field

decimal number

None.

ImpressionDiscountSpendDescriptor

Descriptor of field containing discount impression spend

string

None.

ImpressionDiscountSpendDiscountPercentage

Percentage discount to be applied to discount impression spend field

decimal number

None.

ImpressionRevenueShareDescriptor

Descriptor of field containing impression revenue share

string

None.

ImpressionRevenueShareDiscountPercentage

Percentage discount to be applied to impression revenue share field

decimal number

None.

ClickCountDescriptor

Descriptor of field containing click count

string

None.

ClickGrossSpendDescriptor

Descriptor of field containing gross click spend

string

None.

ClickGrossSpendDiscountPercentage

Percentage discount to be applied to gross click spend field

decimal number

None.

ClickDiscountSpendDescriptor

Descriptor of field containing discount click spend

string

None.

ClickDiscountSpendDiscountPercentage

Percentage discount to be applied to discount click spend field

decimal number

None.

ClickRevenueShareDescriptor

Descriptor of field containing click revenue share

string

None.

ClickRevenueShareDiscountPercentage

Percentage discount to be applied to click revenue share field

decimal number

None.

EventCountDescriptor

Descriptor of field containing event count

string

None.

EventGrossSpendDescriptor

Descriptor of field containing gross event spend

string

None.

EventGrossSpendDiscountPercentage

Percentage discount to be applied to gross event spend field

decimal number

None.

EventDiscountSpendDescriptor

Descriptor of field containing discount event spend

string

None.

EventDiscountSpendDiscountPercentage

Percentage discount to be applied to discount event spend field

decimal number

None.

EventRevenueShareDescriptor

Descriptor of field containing event revenue share

string

None.

EventRevenueShareDiscountPercentage

Percentage discount to be applied to event revenue share field

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "feedId": 2,
  "enabled": true,
  "nextTimestampToFetch": "sample string 3",
  "numberOfHoursToDelay": 1,
  "feedReportUrl": "sample string 4",
  "format": "sample string 5",
  "columnDelimiter": "sample string 6",
  "rowDelimiter": "sample string 7",
  "currency": "sample string 8",
  "currencyScalar": 1,
  "implicitPublisherId": 1,
  "publisherNumberDescriptor": "sample string 9",
  "publisherNumberPrefixDelimiter": "sample string 10",
  "publisherNumberSuffixDelimiter": "sample string 11",
  "subPublisherDescriptor": "sample string 12",
  "subPublisherPrefixDelimiter": "sample string 13",
  "providerSearchCountDescriptor": "sample string 14",
  "impressionCountDescriptor": "sample string 15",
  "impressionGrossSpendDescriptor": "sample string 16",
  "impressionGrossSpendDiscountPercentage": 1.1,
  "impressionDiscountSpendDescriptor": "sample string 17",
  "impressionDiscountSpendDiscountPercentage": 1.1,
  "impressionRevenueShareDescriptor": "sample string 18",
  "impressionRevenueShareDiscountPercentage": 1.1,
  "clickCountDescriptor": "sample string 19",
  "clickGrossSpendDescriptor": "sample string 20",
  "clickGrossSpendDiscountPercentage": 1.1,
  "clickDiscountSpendDescriptor": "sample string 21",
  "clickDiscountSpendDiscountPercentage": 1.1,
  "clickRevenueShareDescriptor": "sample string 22",
  "clickRevenueShareDiscountPercentage": 1.1,
  "eventCountDescriptor": "sample string 23",
  "eventGrossSpendDescriptor": "sample string 24",
  "eventGrossSpendDiscountPercentage": 1.1,
  "eventDiscountSpendDescriptor": "sample string 25",
  "eventDiscountSpendDiscountPercentage": 1.1,
  "eventRevenueShareDescriptor": "sample string 26",
  "eventRevenueShareDiscountPercentage": 1.1
}

application/xml, text/xml

Sample:
<APIFeedReportDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <ClickCountDescriptor>sample string 19</ClickCountDescriptor>
  <ClickDiscountSpendDescriptor>sample string 21</ClickDiscountSpendDescriptor>
  <ClickDiscountSpendDiscountPercentage>1.1</ClickDiscountSpendDiscountPercentage>
  <ClickGrossSpendDescriptor>sample string 20</ClickGrossSpendDescriptor>
  <ClickGrossSpendDiscountPercentage>1.1</ClickGrossSpendDiscountPercentage>
  <ClickRevenueShareDescriptor>sample string 22</ClickRevenueShareDescriptor>
  <ClickRevenueShareDiscountPercentage>1.1</ClickRevenueShareDiscountPercentage>
  <ColumnDelimiter>sample string 6</ColumnDelimiter>
  <Currency>sample string 8</Currency>
  <CurrencyScalar>1</CurrencyScalar>
  <Enabled>true</Enabled>
  <EventCountDescriptor>sample string 23</EventCountDescriptor>
  <EventDiscountSpendDescriptor>sample string 25</EventDiscountSpendDescriptor>
  <EventDiscountSpendDiscountPercentage>1.1</EventDiscountSpendDiscountPercentage>
  <EventGrossSpendDescriptor>sample string 24</EventGrossSpendDescriptor>
  <EventGrossSpendDiscountPercentage>1.1</EventGrossSpendDiscountPercentage>
  <EventRevenueShareDescriptor>sample string 26</EventRevenueShareDescriptor>
  <EventRevenueShareDiscountPercentage>1.1</EventRevenueShareDiscountPercentage>
  <FeedId>2</FeedId>
  <FeedReportUrl>sample string 4</FeedReportUrl>
  <Format>sample string 5</Format>
  <Id>1</Id>
  <ImplicitPublisherId>1</ImplicitPublisherId>
  <ImpressionCountDescriptor>sample string 15</ImpressionCountDescriptor>
  <ImpressionDiscountSpendDescriptor>sample string 17</ImpressionDiscountSpendDescriptor>
  <ImpressionDiscountSpendDiscountPercentage>1.1</ImpressionDiscountSpendDiscountPercentage>
  <ImpressionGrossSpendDescriptor>sample string 16</ImpressionGrossSpendDescriptor>
  <ImpressionGrossSpendDiscountPercentage>1.1</ImpressionGrossSpendDiscountPercentage>
  <ImpressionRevenueShareDescriptor>sample string 18</ImpressionRevenueShareDescriptor>
  <ImpressionRevenueShareDiscountPercentage>1.1</ImpressionRevenueShareDiscountPercentage>
  <NextTimestampToFetch>sample string 3</NextTimestampToFetch>
  <NumberOfHoursToDelay>1</NumberOfHoursToDelay>
  <ProviderSearchCountDescriptor>sample string 14</ProviderSearchCountDescriptor>
  <PublisherNumberDescriptor>sample string 9</PublisherNumberDescriptor>
  <PublisherNumberPrefixDelimiter>sample string 10</PublisherNumberPrefixDelimiter>
  <PublisherNumberSuffixDelimiter>sample string 11</PublisherNumberSuffixDelimiter>
  <RowDelimiter>sample string 7</RowDelimiter>
  <SubPublisherDescriptor>sample string 12</SubPublisherDescriptor>
  <SubPublisherPrefixDelimiter>sample string 13</SubPublisherPrefixDelimiter>
</APIFeedReportDefinition>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.