Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide

getAllAdvanced

Queries all recipients that are contained in a specific recipient list in Optimizely Campaign.

The selection can be limited to a specified target group. This method can be replaced by the .NET replacement method getAllAdvancedFlat.

Type: String[ ] [ ]

Parameters

Name

Type

Value

sessionId

String

ID of the session

recipientListId

long

ID of the recipient list

attributeNames

Stringlec

Names of the fields, whose recipient data shall be queried

recipientFilterId

long

(optional) ID of the target group

If the value is greater than 0, only recipients that match the target group with this ID are returned. If you do not want to use a target group, set the value to 0.

orderByAttribute

String

The name of the attribute (e.g., firstname) used for sorting.

If you set the value to NULL, sorting is disabled.

ascendingSortOrder

Boolean

  • true – Recipient list is sorted in ascending order.
  • false – Recipient list is sorted in descending order.
  • *Note:This parameter is ineffective if you set the value of the previous parameter,orderByAttribute**, to NULL.

pageStart

int

The number of the first recipient to be returned

pageSize

int

The total number of recipients to be returned

Return values

All recipients that are contained in the recipient list.

Returns an array of strings containing an array of strings with the attribute names for each recipient according to the given attribute names.

Code structure

String[][] getAllAdvanced(String sessionId, long recipientListId, String[] attributeNames, long recipientFilterId, String orderByAttribute, boolean ascendingSortOrder, int pageStart, int pageSize)