LinkedIn · Schema

DmpSegment

DmpSegment from LinkedIn API

BusinessCareersMarketingProfessional NetworkingRecruitingSocial MediaFortune 1000

Properties

Name Type Description
id integer Unique identifier for the DMP segment
name string Display name of the segment
account string URN of the sponsore account
accessPolicy string Access policy for the segment
type string Type of DMP segment
sourcePlatform string Source platform for the segment data
status string Current status of the segment
matchedCount integer Number of matched records
inputCount integer Total number of input records
audienceSize integer Size of the audience
destinations array
View JSON Schema on GitHub

JSON Schema

linkedin-marketing-audience-dmp-segment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/linkedin/refs/heads/main/json-schema/linkedin-marketing-audience-dmp-segment-schema.json",
  "title": "DmpSegment",
  "description": "DmpSegment from LinkedIn API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique identifier for the DMP segment",
      "example": 987654321
    },
    "name": {
      "type": "string",
      "description": "Display name of the segment",
      "example": "DMP segment for CSV uploads"
    },
    "account": {
      "type": "string",
      "description": "URN of the sponsore account",
      "example": "urn:li:sponsoredAccount:123456"
    },
    "accessPolicy": {
      "type": "string",
      "enum": [
        "PRIVATE",
        "PUBLIC"
      ],
      "description": "Access policy for the segment",
      "example": "PRIVATE"
    },
    "type": {
      "type": "string",
      "enum": [
        "COMPANY_LIST_UPLOAD",
        "USER_LIST_UPLOAD",
        "COMPANY_STREAMING",
        "USER_STREAMING"
      ],
      "description": "Type of DMP segment",
      "example": "COMPANY_LIST_UPLOAD"
    },
    "sourcePlatform": {
      "type": "string",
      "enum": [
        "LIST_UPLOAD",
        "STREAMING"
      ],
      "description": "Source platform for the segment data",
      "example": "LIST_UPLOAD"
    },
    "status": {
      "type": "string",
      "enum": [
        "PROCESSING",
        "READY",
        "EXPIRED",
        "FAILED"
      ],
      "description": "Current status of the segment",
      "example": "READY"
    },
    "matchedCount": {
      "type": "integer",
      "description": "Number of matched records",
      "example": 5000
    },
    "inputCount": {
      "type": "integer",
      "description": "Total number of input records",
      "example": 6000
    },
    "audienceSize": {
      "type": "integer",
      "description": "Size of the audience",
      "example": 4500
    },
    "destinations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SegmentDestination"
      }
    }
  },
  "required": [
    "name",
    "account",
    "type",
    "sourcePlatform"
  ]
}