Q4-2024 Release

You can now use the BlueConic REST API v2 and Python API to export group data to third-party systems based on specific BlueConic segment definitions. When a segment is evaluated and profiles are returned, the matching group data is included in separate sections of the API response, similar to how Segments are handled. This allows you to access both profile and associated group information efficiently.

In the REST API, this is achieved using the expand filter. The following options were added as part of this release:

• Use profiles.profile.groups to include all group information associated with profiles.

• Use profiles.profile.matchingGroups to include only the groups that match the segment criteria.

In the Python API, this functionality is provided through two new parameters: groups and matching_groups.

This enhancement removes the dependency on private APIs or external platforms (e.g., Salesforce Marketing Cloud) to configure this type of filtering. It improves platform flexibility and efficiency, allowing you to manage your group data more effectively for precise targeting. Additionally, it helps you execute highly personalized use cases based on users' group affiliations.

Note: This Groups API export functionality is now available through export goals in the SFTP Connection, as outlined in this entry below.

Seeing a sample API response

In this example, group data is returned in separate sections (matchingGroups and groups), allowing for a clear and organized representation of the data.

{
  "id": "41ebc321-b02b-4e8a-a368-82995c81fb18",
  "creationDate": "2023-03-27T10:36:11.990Z",
  "privacyLegislation": "GDPR",
  "consentedObjectives": ["objective1"],
  "refusedObjectives": ["objective2"],
  "properties": [
    {"id": "all_companies", "values": ["company_A", "company_B"]},
    {"id": "favorite_company", "values": ["company_B"]},
    {"id": "visitclicks", "values": ["1"]}
  ],
  "segments": [{"id": "bdd64355-2d45-411b-a5ea-0bcf87318f35", "name": "Export test segment"}],
  "matchingGroups": [
    {"profilePropertyId": "all_companies", "groupIds": ["company_A"]},
    {"profilePropertyId": "favorite_company", "groupIds": ["company_B"]}
  ],
  "groups": [
    {
      "id": "company_A",
      "groupTypeId": "company",
      "creationDate": "2023-03-27T10:36:11.990Z",
      "lastModifiedDate": "2024-01-10T12:52:44.816Z",
      "properties": [
        {"id": "city", "values": ["Nijmegen"]},
        {"id": "employees", "values": ["50"]}
      ]
    },
    {
      "id": "company_B",
      "groupTypeId": "company",
      "creationDate": "2023-03-27T10:36:11.990Z",
      "lastModifiedDate": "2024-01-10T12:52:44.816Z",
      "properties": [
        {"id": "city", "values": ["Boston"]},
        {"id": "employees", "values": ["100"]}
      ]
    }
  ]
}