API Guide
API GuideDeveloper Guide
  • Welcome to the API Guide
  • Getting Started
    • Introduction
    • Prerequisites
  • Authentication
  • Endpoint
    • Profile API
      • Get Customer Profile
      • Get Customer ID by phone number
    • Segment API
      • Listing Segments
      • Create new Segment
        • Upload file data for Segment
      • Export data Segment
      • Download exported Segment data
        • Check Segment exporting status
    • Event API
      • Get Event(s) List
      • Get Event History
    • Item API
      • Get Business Object(s) List
      • Get BO Attributes
      • Search Item
      • Explore Item
    • Promotion API
    • App Inbox API
      • Get Message Detail
      • Update Message
      • Count Message Unread
      • Mark All As Read
      • Get Message Performance
      • Get Catalog Performance
      • Get Destination
Powered by GitBook
On this page
  • Introduction
  • Base URL
  • Authentication
  • Error Handling
  1. Endpoint

Segment API

PreviousGet Customer ID by phone numberNextListing Segments

Last updated 6 months ago

Introduction

The Segment API endpoints provide access to our customer/visitor segment information. These endpoints enable you to retrieve a list of segments, create new segments, upload customer/visitor info to existing segments, and export/download segment data.

Base URL

All requests to the Profile API endpoints should be made to the following base URL:

http://api.ants.tech/access/api/segment

Authentication

To access these endpoints, you will need to authenticate your requests using OAuth 2.0 and ensure that the access token is authenticated with the scope segment. Please refer to our for details on how to obtain an access token.

Error Handling

Our API follows standard HTTP status codes for indicating the success or failure of a request. In case of an error, additional information will be provided in the response body.

Authentication Guide