POST api/Partner/GetFrantzSegments

Get required segments for the Frantz pixel script request. The API-call will return a single item if a campaign id is referenced. Otherwise the call will return a list of segment combinations according to the requested segment level, using the following rules:- If you request industries on level 1, only level 1 items will be populated in the response.- If you request categories on level 2, bot level 1 and level 2 items will be populated in the response as they are pre-linked to each other. This is the minimum required level for the Frantz pixel script.- If you request specialities on level 3 - then both level 1,2 and 3 data will be returned for segment combinations already configured by Frantz. If not configured, the returning item will only return a level 3 along with the StyrkKode property and both industry and category will be null for that current segment item. NOTE! If you want to use an alias for the speciality name on level 3 to build your audience by using a more convenient naming of the speciality, this will be allowed as long as you pass the corresponding 4-digit StyrkKode reference to the originating speciality

Request Information

URI Parameters

None.

Body Parameters

FrantzSegmentsRequest

Name	Description	Type	Additional information
apiToken	API Token provided using the Auth method	string	Required
segmentLevel	The level which you require data from with 4 possible input values: 0 -> Fixed list which are already configured as a joined segments 1 -> Free list of industries 2 -> Free list of categories 3 -> Free listof specialities	SegmentLevel	None.
feAdId	Get segments from an existing campaign. When this property is set, the RequestedLevel property is ignored	integer	None.

Request Formats

application/json

Sample:

{
  "apiToken": "bbb196fc-2699-4653-bf2b-811e00f7b443",
  "segmentLevel": 0,
  "feAdId": null
}

text/json

Sample:

{
  "apiToken": "sample string 1",
  "segmentLevel": 0,
  "feAdId": 1
}

Response Information

Resource Description

JsonResultOfFrantzSegmentsResponse

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

Response Formats

application/json, text/json

Sample:

{
  "Segments": [
    {
      "SegmentLevel": 1,
      "AudienceId": 609,
      "Industry": "Helse og sosial",
      "IndustryReach": 76230,
      "Category": "",
      "CategoryReach": 0,
      "Speciality": "",
      "SpecialityReach": 0,
      "StyrkKode": null
    },
    {
      "SegmentLevel": 2,
      "AudienceId": 631,
      "Industry": "Helse og sosial",
      "IndustryReach": 76230,
      "Category": "Bioingeniør",
      "CategoryReach": 1366,
      "Speciality": "",
      "SpecialityReach": 0,
      "StyrkKode": null
    },
    {
      "SegmentLevel": 3,
      "AudienceId": 753,
      "Industry": "Helse og sosial",
      "IndustryReach": 76230,
      "Category": "Leder innenfor helsetjenester",
      "CategoryReach": 5240,
      "Speciality": "Helse og omsorgssjefer",
      "SpecialityReach": 1200,
      "StyrkKode": 1342
    }
  ],
  "CountSegments": 3,
  "TokenExpiracy": "2024-11-17T00:00:00+01:00",
  "StatusCode": 200,
  "StatusMessage": "Success"
}