GET api/advertisement/category/{id}?PageNumber={PageNumber}&PageSize={PageSize}&HasPaging={HasPaging}&Field={Field}&Direction={Direction}

Request Information

URI Parameters

Name	Type	Additional information
id	integer	Required
CompanyIDs	Collection of integer	None.
AdvertisementTypeIDs	Collection of integer	None.
CategoryIDs	Collection of integer	None.
ServiceAreaIDs	Collection of integer	None.
StartDate	date	None.
EndDate	date	None.
IsActive	boolean	None.
FromDate	date	None.
ToDate	date	None.
PageNumber	integer	None.
PageSize	integer	None.
HasPaging	boolean	None.
Field	string	None.
Direction	SortDirection	None.

Body Parameters

None.

Response Information

Resource Description

AdvertisementReportCollectionViewModel

Name	Description	Type	Additional information
TotalItemCount		integer	None.
Items		Collection of AdvertisementReportTotalViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalItemCount": 1,
  "Items": [
    {
      "Impressions": 1,
      "Clicks": 2,
      "AdvertisementID": 3,
      "CompanyID": 4,
      "CompanyName": "sample string 5",
      "AdvertisementTypeID": 6,
      "AdvertisementType": "sample string 7",
      "CategoryID": 1,
      "Category": "sample string 8",
      "ServiceAreaID": 1,
      "ServiceArea": "sample string 9",
      "StartDate": "2026-04-02T04:42:50.6484835-04:00",
      "EndDate": "2026-04-02T04:42:50.6484835-04:00"
    },
    {
      "Impressions": 1,
      "Clicks": 2,
      "AdvertisementID": 3,
      "CompanyID": 4,
      "CompanyName": "sample string 5",
      "AdvertisementTypeID": 6,
      "AdvertisementType": "sample string 7",
      "CategoryID": 1,
      "Category": "sample string 8",
      "ServiceAreaID": 1,
      "ServiceArea": "sample string 9",
      "StartDate": "2026-04-02T04:42:50.6484835-04:00",
      "EndDate": "2026-04-02T04:42:50.6484835-04:00"
    }
  ]
}

application/xml, text/xml

Sample:

<AdvertisementReportCollectionViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CisReports.Api.Models">
  <Items>
    <AdvertisementReportTotalViewModel>
      <AdvertisementID>3</AdvertisementID>
      <AdvertisementType>sample string 7</AdvertisementType>
      <AdvertisementTypeID>6</AdvertisementTypeID>
      <Category>sample string 8</Category>
      <CategoryID>1</CategoryID>
      <CompanyID>4</CompanyID>
      <CompanyName>sample string 5</CompanyName>
      <EndDate>2026-04-02T04:42:50.6484835-04:00</EndDate>
      <ServiceArea>sample string 9</ServiceArea>
      <ServiceAreaID>1</ServiceAreaID>
      <StartDate>2026-04-02T04:42:50.6484835-04:00</StartDate>
      <Clicks>2</Clicks>
      <Impressions>1</Impressions>
    </AdvertisementReportTotalViewModel>
    <AdvertisementReportTotalViewModel>
      <AdvertisementID>3</AdvertisementID>
      <AdvertisementType>sample string 7</AdvertisementType>
      <AdvertisementTypeID>6</AdvertisementTypeID>
      <Category>sample string 8</Category>
      <CategoryID>1</CategoryID>
      <CompanyID>4</CompanyID>
      <CompanyName>sample string 5</CompanyName>
      <EndDate>2026-04-02T04:42:50.6484835-04:00</EndDate>
      <ServiceArea>sample string 9</ServiceArea>
      <ServiceAreaID>1</ServiceAreaID>
      <StartDate>2026-04-02T04:42:50.6484835-04:00</StartDate>
      <Clicks>2</Clicks>
      <Impressions>1</Impressions>
    </AdvertisementReportTotalViewModel>
  </Items>
  <TotalItemCount>1</TotalItemCount>
</AdvertisementReportCollectionViewModel>