POST api/Partner/GetCampaignStatistics

Get statistical data for the campaign. The best practice is to run this call once a day and save the values with a timestamp for when to refresh. Refresh is recommended to be run in the morning some time after 07:00AM as this will ensure that the numbers from the previous day is available. It may take several seconds to generate the statistical data depending on the amount of base data available. E.g. a campaign running at day 4 will naturally have less data than the one running at day 14). It is not recommended to run this call in the UI directly as it will provide poor user experience (wait time). The data returned gives a live view at the point in time when the request is performed. Meta auto-campaign views and clicks will be returned as they the are stored in Meta directly. The report URL in the response will be the same every time for the same campaign and will provide a simplified customer branded insights report in relation to the statistical data returned in the response.

Request Information

URI Parameters

None.

Body Parameters

campaign request

FrantzCampaignStatisticsRequest

Name	Description	Type	Additional information
apiToken	API Token provided using the Auth method	string	Required
feAdId	The campaign to fetch statistics for	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "apiToken": "bbb196fc-2699-4653-bf2b-811e00f7b443",
  "feAdId": 435371
}

Response Information

Resource Description

JsonResultOfFrantzCampaignStatisticsResponse

Name	Type	Additional information
Content	FrantzCampaignStatisticsResponse	None.
SerializerSettings	JsonSerializerSettings	None.
Encoding	Encoding	None.
Request	HttpRequestMessage	None.

Response Formats

application/json, text/json

Sample:

{
  "ReportUrl": "https://login.frantz.no/Dashboard/AutoCampaignReport?code=fe218bf7-f180-41ab-a290-88f81ed52ae3",
  "TokenExpiracy": "2024-11-17T00:00:00+01:00",
  "StatsData": [
    {
      "feAdId": 435371,
      "mediaName": "Direktetrafikk",
      "avgTime": 67.9,
      "bannerViews": 0,
      "bannerClicks": 0,
      "landingpageViews": 258,
      "clickedReadMore": 226,
      "hasReadText": 74,
      "searchButton": 6
    },
    {
      "feAdId": 500741,
      "mediaName": "Meta Autokampanje (Facebook, Instagram, Messenger)",
      "avgTime": 59.2,
      "bannerViews": 89877,
      "bannerClicks": 1372,
      "landingpageViews": 1059,
      "clickedReadMore": 976,
      "hasReadText": 469,
      "searchButton": 39
    }
  ],
  "StatusCode": 200,
  "StatusMessage": "Success"
}