Segment API

Provides endpoints for managing audience segments, including creating, updating, deleting, and retrieving segment details. Supports operations like extending segment end dates, appending data, and loading reusable or remote segments for advanced audience targeting.

Segment - Properties

Property	Description
segmentId	Unique identifier for the segment.
segmentRefId	Reference ID for the segment (nullable).
categoryId	Category ID for the segment (nullable).
description	Description of the segment.
extend	Indicates if the segment is set to extend automatically.
active	Indicates if the segment is currently active.
accountId	ID of the account associated with the segment.
audienceId	ID of the audience this segment belongs to.
platformId	ID of the platform where the segment is used.
isRecurring	Indicates if the segment is recurring.
isSystemGenerated	Indicates if the segment was generated by the system.
country	Numeric country code associated with the segment.
startDate	Start date/time of the segment (ISO 8601 format, UTC).
endDate	End date/time of the segment (ISO 8601 format, UTC).
status	Human-readable status of the segment (e.g., "Active").
statusId	Numeric ID representing the segment status.
userName	Name of the user who created or manages the segment.
userId	ID of the user who created or manages the segment.
totalLogCount	Total number of logs/events for the segment.
totalReadyCount	Total number of ready items (nullable).
totalProcessingCount	Total number of items currently processing (nullable).
totalPendingCount	Total number of pending items.
totalUploadCount	Total number of uploads for the segment.
totalFailedCount	Total number of failed items (nullable).
totalNoDataCount	Total number of items with no data (nullable).
totalSegmentUploadCount	Total number of segment uploads.
id	Internal unique identifier for the segment record.
name	Name of the segment.
created	Timestamp when the segment was created (ISO 8601 format, UTC).
updated	Timestamp when the segment was last updated (ISO 8601 format, UTC).

Account - Properties

Property	Description
id	Unique identifier for the account.
name	Name of the account.
platformId	ID of the platform associated with the account.
platformName	Internal name of the platform.
platformDisplayName	User-friendly display name of the platform.
agencyId	ID of the agency that owns the account.
accountTypeId	Type ID of the account (nullable).
advertiserId	Advertiser ID (nullable).
clientId	Client identifier within the platform.
agencyName	Name of the agency that owns the account.
accountTypeName	Name of the account type (nullable).
defaultSegmentPricingCategoryId	Default segment pricing category ID (nullable).
created	Timestamp when the account was created (ISO 8601 format, UTC).
updated	Timestamp when the account was last updated (ISO 8601 format, UTC).

GET /segment/audience:{audienceid:int}

Purpose

Create an audience within a campaign for segmentation.

Request (cURL)

curl --location '{{_.base_url}}/api/audience/create/api/audience/createcrmaudience' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \
--data '{
  "name": "{{_.audience_name}}",
  "description": "{{_.audience_description}}",
  "campaignId": {{_.campaign_id}}
}'

Request Body

{
  "name": "{{_.audience_name}}",
  "description": "{{_.audience_description}}",
  "campaignId": "{{_.campaing_id}}",
}

Notes:

• Replace template variables with actual values.

• Strings must be quoted in JSON.

• Use the cookie from login for authentication.

• *Description is optional.

Response

{
    "data": [
        {
            "segmentId": "1",
            "segmentRefId": null,
            "categoryId": null,
            "description": "",
            "extend": true,
            "active": true,
            "accountId": 1,
            "audienceId": 1,
            "platformId": 1,
            "isRecurring": false,
            "isSystemGenerated": false,
            "country": 150,
            "startDate": "2024-10-25T09:50:52.254Z",
            "endDate": "2025-12-20T13:24:34.603Z",
            "status": "Active",
            "statusId": 1,
            "userName": "User",
            "userId": 1,
            "totalLogCount": 95,
            "totalReadyCount": null,
            "totalProcessingCount": null,
            "totalPendingCount": 94,
            "totalUploadCount": 1,
            "totalFailedCount": null,
            "totalNoDataCount": null,
            "totalSegmentUploadCount": 310730,
            "id": 2041156,
            "name": "Webshops",
            "created": "2024-10-25T09:51:02.786183Z",
            "updated": "2025-12-17T10:36:57.492204Z"
        }
    ]
}

GET /segment/{segmentid:int}

Purpose

Create an audience within a campaign for segmentation.

Request (cURL)

curl --location --request GET '{{_.base_url}}/Segment/loadsegmentbyid/123' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \

Response

{
    "data": {
        "segment": {
            "segmentId": "21636314",
            "segmentRefId": null,
            "categoryId": null,
            "description": "",
            "extend": true,
            "active": true,
            "accountId": 562,
            "audienceId": 43519,
            "platformId": 57,
            "isRecurring": false,
            "isSystemGenerated": false,
            "country": 150,
            "startDate": "2024-10-25T09:50:52.254Z",
            "endDate": "2025-12-20T13:24:34.603Z",
            "status": "Active",
            "statusId": 1,
            "userName": "User",
            "userId": 439,
            "totalLogCount": 95,
            "totalReadyCount": null,
            "totalProcessingCount": null,
            "totalPendingCount": 94,
            "totalUploadCount": 1,
            "totalFailedCount": null,
            "totalNoDataCount": null,
            "totalSegmentUploadCount": 310730,
            "id": 2041156,
            "name": "Webshops",
            "created": "2024-10-25T09:51:02.786183Z",
            "updated": "2025-12-17T10:36:57.492204Z"
        },
        "account": {
            "id": 562,
            "name": "LinkedIn dA",
            "platformId": 57,
            "platformName": "LinkedIn",
            "platformDisplayName": "LinkedIn",
            "agencyId": 1,
            "accountTypeId": null,
            "advertiserId": null,
            "clientId": "509631947",
            "agencyName": "digitalAudience",
            "accountTypeName": null,
            "defaultSegmentPricingCategoryId": null,
            "created": "2024-10-25T09:48:35.426089Z",
            "updated": "2024-10-25T09:48:35.426089Z"
        },
        "isPlatformSegmentInfoAvailable": true
    },
    "status": {
        "statusCode": 0,
        "message": null
    },
    "success": true
}

POST /segment/updateenddate

Purpose

Update the end date of a segment

Request (cURL)

curl --location '{{_.base_url}}/api/segment/updateenddate' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123' \
--data '{
    "segmentid": 1,
	"endDate": "2025-12-16T11:36:10.6878666Z"
}'

Response

{
    "data": {
        "segmentId": "1",
        "segmentRefId": null,
        "categoryId": null,
        "description": "",
        "extend": true,
        "active": true,
        "accountId": 1,
        "audienceId": 1,
        "platformId": 1,
        "isRecurring": false,
        "isSystemGenerated": false,
        "country": 150,
        "startDate": "2024-10-25T09:50:52.254Z",
        "endDate": "2025-12-16T11:36:10.687866Z",
        "status": "Expired",
        "statusId": 2,
        "userName": "User",
        "userId": 1,
        "totalLogCount": 95,
        "totalReadyCount": null,
        "totalProcessingCount": null,
        "totalPendingCount": 94,
        "totalUploadCount": 1,
        "totalFailedCount": null,
        "totalNoDataCount": null,
        "totalSegmentUploadCount": 310730,
        "id": 2041156,
        "name": "Webshops",
        "created": "2024-10-25T09:51:02.786183Z",
        "updated": "2025-12-18T14:10:03.225793Z"
    },
    "status": {
        "statusCode": 0,
        "message": null
    },
    "success": true
}

DELETE /segment/{segmentid:int}

Purpose

Delete a segment

Request (cURL)

curl --location --request DELETE '{{_.base_url}}/segment/delete/123' \
--header 'Content-Type: application/json' \
--header 'Cookie: digitalAudience=123'

Response

{
    "success": true
}