Skip to content
Toposort Logo
ad-server

Segments API

Topsort’s Segments API allows our clients to create and manage groups of users for targeting purposes. After creating segments on our platform, they can be used as targeting in the campaign creation.

  1. Uploading Users to a Segment

    Once a segment is created, users can be uploaded to it using our APIs. Topsort support three actions:

    • Add: Append new users to the existing segment, without making changes to existing ones.
    • Remove: Delete specific users from the segment.
    • Replace: Overwrite the entire segment with a new user list

    User lists must follow this specification:

    • File format is .txt
    • No headers
    • One Opaque User ID per row, without emails or personal information.

  2. Use in Campaigns

    Segments are used as targeting options in campaigns. The same Opaque User ID uploaded to the segments should be used on the auction request, to guarantee the auction engine can match it with the corresponding segment.