GET api/v1/partners/new/report

Get a partner's report.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Authentication		AuthenticationModel	Required
Request		PartnerReportRequestModel	Required

Request Formats

application/json, text/json

Sample:

{
  "Authentication": {
    "Id": "170200123 - sample only, user your ID",
    "Key": "467512342123 - sample only, user your Key"
  },
  "Request": {
    "PartnerName": "Pixar",
    "RequesterEmail": null,
    "Filter": "true/false (option to override database default for filtering internal testing)",
    "PredefinedRange": "this month | this year | last month | last year | today | yesterday - don't include Range if this field is populated",
    "Range": {
      "StartDate": "2025-12-03 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)",
      "EndDate": "2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)"
    }
  }
}

application/xml, text/xml

Sample:

<PartnersReportBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
  <Authentication>
    <Id>170200123 - sample only, user your ID</Id>
    <Key>467512342123 - sample only, user your Key</Key>
  </Authentication>
  <Request>
    <Filter>true/false (option to override database default for filtering internal testing)</Filter>
    <PartnerName>Pixar</PartnerName>
    <PredefinedRange>this month | this year | last month | last year | today | yesterday - don't include Range if this field is populated</PredefinedRange>
    <Range>
      <EndDate>2025-12-04 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)</EndDate>
      <StartDate>2025-12-03 06:57:36 (YYYY-MM-DD HH:MM:SS - UTC format)</StartDate>
    </Range>
    <RequesterEmail i:nil="true" />
  </Request>
</PartnersReportBindingModel>

Response Information

Resource Description

OutgoingPartnerModel

Name	Description	Type	Additional information
Message		MessageModel	None.
Response		IPartnerReportResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": {
    "Code": "sample string 1",
    "Description": "sample string 2"
  },
  "Response": null
}

application/xml, text/xml

Sample:

<OutgoingPartnerModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Models">
  <Message>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </Message>
  <Response i:nil="true" />
</OutgoingPartnerModel>