Audience (module)

Create an audience using structured, field-based filters

POST

http://datashopper.test/api

/v2/m/audiences/build

Create an audience using structured, field-based filters › Request Body

BuildAudienceRequest

type

string · enum · required

Enum values:

advanced_search

b2b

b2c

name

string | null

website_id

integer | null

limit

integer | null · min: 1 · max: 1000000

topic_ids

array | null · maxItems: 5

object[]

Create an audience using structured, field-based filters › Responses

message

string · const · required

Const value: Audience is being built.

data

string[] · minItems: 0 · maxItems: 0 · required

POST/v2/m/audiences/build

curl --request POST \
  --url http://datashopper.test/api/v2/m/audiences/build \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "website_id": 0,
  "type": "advanced_search",
  "limit": 1,
  "topic_ids": [
    0
  ],
  "filters": [
    {
      "field": "event_date",
      "operator": "operator",
      "value_to": "value_to"
    }
  ]
}
'

Example Request Body

{
  "name": "name",
  "website_id": 0,
  "type": "advanced_search",
  "limit": 1,
  "topic_ids": [
    0
  ],
  "filters": [
    {
      "field": "event_date",
      "operator": "operator",
      "value_to": "value_to"
    }
  ]
}

json

Example Responses

{
  "message": "Audience is being built.",
  "data": [
    "string"
  ]
}

json

application/json

List all audiences for your account

GET

http://datashopper.test/api

/v2/m/audiences/fetch

List all audiences for your account › Responses

success

boolean · required

data

Audience[] · required

Poll an audience for status and preview data

GET

http://datashopper.test/api

/v2/m/audiences/fetch/{id}

Poll an audience for status and preview data › path Parameters

id

integer · required

Poll an audience for status and preview data › Responses

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: status, topics, data +2 more
	type = object · requires: status, data, counts +1 more

Properties for Variant 1:

status

string · required

topics

string · required

object · required

counts

string · required

loading_counts

string · required

Export an audience directly as CSV

POST

http://datashopper.test/api

/v2/m/audiences/manage/{id}/export

Export an audience directly as CSV › path Parameters

id

integer · required

Export an audience directly as CSV › Request Body

fields

string

Export an audience directly as CSV › Responses

Audience (ext)B2BTopics

Datamoon API

Audience (module)

Create an audience using structured, field-based filters

POST

http://datashopper.test/api

/v2/m/audiences/build

Create an audience using structured, field-based filters › Request Body

BuildAudienceRequest

type

string · enum · required

Enum values:

advanced_search

b2b

b2c

name

string | null

website_id

integer | null

limit

integer | null · min: 1 · max: 1000000

topic_ids

array | null · maxItems: 5

object[]

Create an audience using structured, field-based filters › Responses

message

string · const · required

Const value: Audience is being built.

data

string[] · minItems: 0 · maxItems: 0 · required

POST/v2/m/audiences/build

curl --request POST \
  --url http://datashopper.test/api/v2/m/audiences/build \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "website_id": 0,
  "type": "advanced_search",
  "limit": 1,
  "topic_ids": [
    0
  ],
  "filters": [
    {
      "field": "event_date",
      "operator": "operator",
      "value_to": "value_to"
    }
  ]
}
'

Example Request Body

{
  "name": "name",
  "website_id": 0,
  "type": "advanced_search",
  "limit": 1,
  "topic_ids": [
    0
  ],
  "filters": [
    {
      "field": "event_date",
      "operator": "operator",
      "value_to": "value_to"
    }
  ]
}

json

Example Responses

{
  "message": "Audience is being built.",
  "data": [
    "string"
  ]
}

json

application/json

List all audiences for your account

GET

http://datashopper.test/api

/v2/m/audiences/fetch

List all audiences for your account › Responses

success

boolean · required

data

Audience[] · required

Poll an audience for status and preview data

GET

http://datashopper.test/api

/v2/m/audiences/fetch/{id}

Poll an audience for status and preview data › path Parameters

id

integer · required

Poll an audience for status and preview data › Responses

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: status, topics, data +2 more
	type = object · requires: status, data, counts +1 more

Properties for Variant 1:

status

string · required

topics

string · required

object · required

counts

string · required

loading_counts

string · required

Export an audience directly as CSV

POST

http://datashopper.test/api

/v2/m/audiences/manage/{id}/export

Export an audience directly as CSV › path Parameters

id

integer · required

Export an audience directly as CSV › Request Body

fields

string

Export an audience directly as CSV › Responses

Audience (ext)B2BTopics