[HTTP GET] ~/campaigns/{campaignId}/reports/competitions

Description: Get a Competitions Report for a specific Campaign

Request Information

URI Parameters

NameDescriptionTypeAdditional information
campaignId

the specific Campaign Id

 integer

Required

Body Parameters

None

Response Information

Description

Successful Response - OK (200):

A Competition Channel Report

Response Content : CompetitionChannelReport

NameDescriptionTypeAdditional information
CompetitionReports

List of child Competition Reports

 Collection of CompetitionReport

None.

Response Codes:

  • 200 - OK
    • The specified Campaign's Competition Channel Report was retrieved and returned successfully.
  • 401 - Unauthorized
    • Request has been denied as it lacks valid Authentication credentials.
  • 403 - Forbidden
    • The user does not have the relevant permissions to perform this action.
  • 404 - NotFound
    • The specified Campaign or it's Competition Channel report was not found.
  • 500 - InternalServerError
    • An error occurred while processing this request.

Formats

application/json, text/json

Sample: 
{
  "CompetitionReports": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "EntryCount": 3,
      "UniqueEntryCount": 4,
      "CorrectEntryCount": 5,
      "CorrectUniqueEntryCount": 6,
      "WinnerCount": 7,
      "IncorrectEntryCount": 8,
      "IncorrectUniqueEntryCount": 9,
      "CorrectEntryRate": 10.1,
      "IncorrectEntryRate": 11.1
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "EntryCount": 3,
      "UniqueEntryCount": 4,
      "CorrectEntryCount": 5,
      "CorrectUniqueEntryCount": 6,
      "WinnerCount": 7,
      "IncorrectEntryCount": 8,
      "IncorrectUniqueEntryCount": 9,
      "CorrectEntryRate": 10.1,
      "IncorrectEntryRate": 11.1
    }
  ]
}

application/csp-report

Sample: 
{"CompetitionReports":[{"Id":1,"Name":"sample string 2","EntryCount":3,"UniqueEntryCount":4,"CorrectEntryCount":5,"CorrectUniqueEntryCount":6,"WinnerCount":7,"IncorrectEntryCount":8,"IncorrectUniqueEntryCount":9,"CorrectEntryRate":10.1,"IncorrectEntryRate":11.1},{"Id":1,"Name":"sample string 2","EntryCount":3,"UniqueEntryCount":4,"CorrectEntryCount":5,"CorrectUniqueEntryCount":6,"WinnerCount":7,"IncorrectEntryCount":8,"IncorrectUniqueEntryCount":9,"CorrectEntryRate":10.1,"IncorrectEntryRate":11.1}]}

application/xml, text/xml

Sample: 
<CompetitionChannelReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/W50API.Models.DTO.Reports">
  <CompetitionReports>
    <CompetitionReport>
      <CorrectEntryCount>5</CorrectEntryCount>
      <CorrectEntryRate>10.1</CorrectEntryRate>
      <CorrectUniqueEntryCount>6</CorrectUniqueEntryCount>
      <EntryCount>3</EntryCount>
      <Id>1</Id>
      <IncorrectEntryCount>8</IncorrectEntryCount>
      <IncorrectEntryRate>11.1</IncorrectEntryRate>
      <IncorrectUniqueEntryCount>9</IncorrectUniqueEntryCount>
      <Name>sample string 2</Name>
      <UniqueEntryCount>4</UniqueEntryCount>
      <WinnerCount>7</WinnerCount>
    </CompetitionReport>
    <CompetitionReport>
      <CorrectEntryCount>5</CorrectEntryCount>
      <CorrectEntryRate>10.1</CorrectEntryRate>
      <CorrectUniqueEntryCount>6</CorrectUniqueEntryCount>
      <EntryCount>3</EntryCount>
      <Id>1</Id>
      <IncorrectEntryCount>8</IncorrectEntryCount>
      <IncorrectEntryRate>11.1</IncorrectEntryRate>
      <IncorrectUniqueEntryCount>9</IncorrectUniqueEntryCount>
      <Name>sample string 2</Name>
      <UniqueEntryCount>4</UniqueEntryCount>
      <WinnerCount>7</WinnerCount>
    </CompetitionReport>
  </CompetitionReports>
</CompetitionChannelReport>