Expand Audience

Expands an audience.

Every call to this endpoint consumes an API credit. If the expand process fails, the credit will be refunded to the company automatically.

Getting Started

URL REQUEST (POST)

https://api.statsocial.com/platform/v0/audiences/{audience_id}/expand

An optinal callback_url url.

{
  "callback_url": "https://yoursite.com/callback",
}

expansion_factor is limited to 10, you can use broken values ​​like 9.50

{
  "expansion_factor": "9.50",
}

remove_seed Remove the seed audience from the new expanded audience

{
  "remove_seed": false,
}

include_seed Include the seed audience in the new expanded audience

{
  "include_seed": true,
}

reapply_exclusions Re-apply the same excluded to the modelled audience

{
  "reapply_exclusions": true,
}

reapply_filters Re-apply the same filters to the modelled audience

{
  "reapply_exclusions": true,
}

Types of parameteres

{
  "callback_url": "string",
  "expansion_factor": int,
  "expansion_name": "string",
  "include_seed": boolean,
  "reapply_exclusions": boolean,
  "reapply_filters": boolean,
  "remove_seed": boolean
}

Let's go to example

In this example we will search for an audience with affinities

note

We create this audience in this example

https://api.statsocial.com/platform/v0/audiences/67454/expand

With This Payload

{
  "callback_url": "https://yoursite.com/callback",
  "expansion_factor": 10,
  "expansion_name": "Audience (Expansion)",
  "include_seed": false,
  "reapply_exclusions": true,
  "reapply_filters": true,
  "remove_seed": true
}

We will receive a json like this

{
    "response": {
        "id": 67589,
        "status": "running"
    },
    "information": {
        "version": "0.0.1"
    }
}