POST api/Partner/GetPixelScript

Generates a landing page pixel script to be set in the header of the landing page. The script could be stored as a blob and inserted or injected into the landingpage at loading time. Requires the id for targeting a unique audience, provided from the GetFrantzSegments call

Request Information

URI Parameters

None.

Body Parameters

FrantzPixelRequest

FrantzPixelAudienceRequest
NameDescriptionTypeAdditional information
apiToken

API Token provided using the Auth method

string

Required

feAdId

6-digit value. Required only in case of changes to an exiting campaign

integer

None.

campaignStartDate

Start date for when the insights data will be available

date

None.

campaignEndDate

Last day when insights data will show up in reports

date

None.

ProjectReference

Your project number/reference

string

Required

Max length: 50

LandingPageUrl

The URL to the campaign landingpage

string

Max length: 256

Title

Title for the job

string

Max length: 255

AudienceId

Unique numerical identifier returned from the GetFrantzSegments API call

integer

None.

STYRK

Unique numerical identifier from the 'International Standard Classification of Occupations (ISCO)', ISCO-08. See API-call GetFrantzSegments

integer

None.

ApplicationDueDate

The application due date. Could be a specific date or a short text

string

Max length: 20

BannerShortText

Short text job description for the banner

string

Max length: 255

BannerLogoUrl

A URL to the banner company logo

string

Max length: 512

BannerImageUrl

A URL to the banner background image

string

Max length: 512

Request Formats

application/json, text/json

Sample:
{
  "apiToken": "bbb196fc-2699-4653-bf2b-811e00f7b443",
  "feAdId": null,
  "campaignStartDate": "2024-10-19T00:00:00+02:00",
  "campaignEndDate": "2024-11-01T00:00:00+01:00",
  "ProjectReference": "123456",
  "LandingPageUrl": "http://www.frantz.no/",
  "Title": "Er du vår nye prosjektleder?",
  "AudienceId": 740,
  "STYRK": 2423,
  "ApplicationDueDate": "11/17/2024",
  "BannerShortText": "Blir du insiprert av kort vei fra idé til beslutning og ønsker å jobbe i små team er kanskje dette nettopp din nye jobb!",
  "BannerLogoUrl": "https://frantz.no/wp-content/uploads/2022/03/FrantzLogo_MediaBuyingPlatform_recruiters.png",
  "BannerImageUrl": "https://frantz.no/wp-content/uploads/2022/03/Harstad-1-768x461-1.jpeg"
}

Response Information

Resource Description

Returns a FrantzPartnerPixelResponse object containing the landingpage script in String format

JsonResultOfFrantzPartnerPixelResponse
NameDescriptionTypeAdditional information
Content

FrantzPartnerPixelResponse

None.

SerializerSettings

JsonSerializerSettings

None.

Encoding

Encoding

None.

Request

HttpRequestMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "landingPageTopScript": "<script type='text/javascript'>var feAdId='435371';var fIndId=1;var fTitId=1;var fSpeId=25;var fbInit...var snapPixelAudienceTargets='Pageview';var uaCode='';</script>",
  "landingPageBottomScript": "<script crossorigin='anonymous' async='' r='435371' src='https://api.frantz.no/scripts/tech/frantzTech.min.js'></script>",
  "frantzPixelStaticVars": "var feAdId='435371';var fIndId=1;var fTitId=1;var fSpeId=25;var fbInit...var snapPixelAudienceTargets='Pageview';var uaCode='';",
  "frantzPixelScript": "<script crossorigin='anonymous' async='' r='435371' src='https://api.frantz.no/scripts/tech/frantzTech.min.js'></script>",
  "TokenExpiracy": "2024-11-17T00:00:00+01:00",
  "feAdId": 435371,
  "StatusCode": 200,
  "StatusMessage": "Success"
}