API docs by Redocly

Audiences API (1.0.0)

The Audience API helps LiveIntent partners to programmatically exchange data for creating and managing audiences. The API enables a high level of automation, which helps LiveIntent partners increase efficiency, reduce labor requirements, and improve audience delivery time. As a LiveIntent partner, you can leverage the Audience API to create and manage Custom Audience. This API supports the HTTP GET, POST, and PATCH methods. The following sections describe how to call the endpoints.

List audiences for the specified account, or all a

List audiences for the specified account, or all audiences if no accountId is provided.

Authorizations:
Bearer
query Parameters
page
integer <int32>

the page number

pageSize
integer <int32>

the page size

updatedAfter
integer <int64>

filter for audiences updated after the provided timestamp (in milliseconds since epoch)

Responses

Response samples

Content type
application/json
{
  • "pageSize": 0,
  • "page": 0,
  • "pages": 0,
  • "entries": [
    ],
  • "totalCount": 0
}

Create a new audience.

Create a new audience.

Authorizations:
Bearer
Request Body schema: application/json
required
dataProviderId
required
integer <int32>
name
required
string
accountId
required
integer <int64>
metadata
object
Default: {}

If not set, this field defaults to the value of the default annotation.

Responses

Request samples

Content type
application/json
{
  • "dataProviderId": 0,
  • "name": "string",
  • "accountId": 0,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "accountId": 0,
  • "dataProviderId": 0,
  • "id": 0,
  • "status": "Active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get the specified audience.

Get the specified audience.

Authorizations:
Bearer
path Parameters
audienceId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "accountId": 0,
  • "dataProviderId": 0,
  • "id": 0,
  • "status": "Active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update the specified audience.

Update the specified audience.

Authorizations:
Bearer
path Parameters
audienceId
required
integer <int64>
Request Body schema: application/json
required
name
string or null
null or StatusUpdateDTO (string)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": { }
}

Response samples

Content type
application/json
{
  • "accountId": 0,
  • "dataProviderId": 0,
  • "id": 0,
  • "status": "Active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "metadata": {
    },
  • "name": "string",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get counts for the specified audience.

Get counts for the specified audience.

Authorizations:
Bearer
path Parameters
audienceId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

Create signed URLs for uploading audience data to

Create signed URLs for uploading audience data to the specified audience.

Authorizations:
Bearer
path Parameters
audienceId
required
integer <int64>
Request Body schema: application/json
required
uploadName
string or null
notificationEmail
string or null
identifierType
required
string
action
required
string

Responses

Request samples

Content type
application/json
{
  • "uploadName": "string",
  • "notificationEmail": "string",
  • "identifierType": "string",
  • "action": "string"
}

Response samples

Content type
application/json
{
  • "signedUrl": "string"
}

List uploads for the specified audience.

List uploads for the specified audience.

Authorizations:
Bearer
path Parameters
audienceId
required
integer <int64>
query Parameters
page
integer <int32>

the page number

pageSize
integer <int32>

the page size

Responses

Response samples

Content type
application/json
{
  • "pageSize": 0,
  • "page": 0,
  • "pages": 0,
  • "entries": [
    ],
  • "totalCount": 0
}

Create a new event tracker audience.

Create a new event tracker audience.

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (AttributionWindow)
required
object or object or object or object or object or object (Json)
name
required
string
appIds
required
Array of strings non-empty
pixelId
required
string
accountId
required
integer <int64>
audienceTtl
required
integer <int32>
conversionId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "attributionWindow": {
    },
  • "body": {
    },
  • "name": "string",
  • "appIds": [
    ],
  • "pixelId": "string",
  • "accountId": 0,
  • "audienceTtl": 0,
  • "conversionId": 0
}

Response samples

Content type
application/json
{
  • "ruleId": 0,
  • "audience": {
    }
}

Search for audiences matching the provided criteri

Search for audiences matching the provided criteria, with optional account scoping.

Authorizations:
Bearer
query Parameters
accountId
integer <int64>

the account id

Request Body schema: application/json
required
page
integer <int32>
Default: 1

If not set, this field defaults to the value of the default annotation.

pageSize
integer <int32>
Default: 30

If not set, this field defaults to the value of the default annotation.

null or (AudienceFilter (AudienceFilter (object) or AudienceFilter (object) or AudienceFilter (object) or AudienceFilter (object) or AudienceFilter (object) or AudienceFilter (object) or AudienceFilter (object) or AudienceFilter (object)))

If not set, this field defaults to the value of the default annotation.

includeInternal
boolean
Default: false

If not set, this field defaults to the value of the default annotation.

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "pageSize": 30,
  • "matches": { },
  • "includeInternal": false
}

Response samples

Content type
application/json
{
  • "pageSize": 0,
  • "page": 0,
  • "pages": 0,
  • "entries": [
    ],
  • "totalCount": 0
}

Update conversion trackers and rule for audiences.

Update conversion trackers and rule for audiences.

Authorizations:
Bearer
Request Body schema: application/json
required
name
string or null
accountId
required
integer <int64>
pvc
integer or null <int64>
audienceId
required
integer <int64>
ruleId
required
integer <int32>
pcc
integer or null <int64>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "accountId": 0,
  • "pvc": 0,
  • "audienceId": 0,
  • "ruleId": 0,
  • "pcc": 0
}

Response samples

Content type
application/json
null

Create a new URL tracker audience.

Create a new URL tracker audience.

Authorizations:
Bearer
Request Body schema: application/json
required
required
object (AttributionWindow)
required
object or object or object or object or object or object (Json)
name
required
string
appIds
required
Array of strings non-empty
pixelId
required
string
accountId
required
integer <int64>
audienceTtl
required
integer <int32>
conversionId
required
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "attributionWindow": {
    },
  • "body": {
    },
  • "name": "string",
  • "appIds": [
    ],
  • "pixelId": "string",
  • "accountId": 0,
  • "audienceTtl": 0,
  • "conversionId": 0
}

Response samples

Content type
application/json
{
  • "ruleId": 0,
  • "audience": {
    }
}