Versium: Online Audience Append

Get online advertising identifiers for a consumer or business person, ready for ad audience matching.

Tool ID: versium_online_audience_append

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'versium_online_audience_append',
  {
    "first": "example",
    "last": "example",
    "email": "jane.doe@example.com"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute versium_online_audience_append --input '{
  "first": "example",
  "last": "example",
  "email": "jane.doe@example.com"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "versium": {
      "version": "example",
      "num_matches": 123,
      "num_results": 123,
      "query_id": "query_123",
      "query_time": 123,
      "results": [
        {}
      ],
      "input_query": {}
    }
  }
}

Use deepline describe versium_online_audience_append --json for the latest machine-readable contract.

Input reference

Return platform-ready online audience identifiers for a consumer or business person.

Name	Type	Required	Default	Details
`payload.first`	`string`	No	—	A person’s first name
`payload.last`	`string`	No	—	A person’s last name
`payload.fullname`	`string`	No	—	A person First and Last name (i.e. John Smith)
`payload.address`	`string`	No	—	A house/building number and street
`payload.address_2`	`string`	No	—	The unit number of an address (i.e. Unit 2)
`payload.city`	`string`	No	—	A city name
`payload.state`	`string`	No	—	A US State two letter abbreviation
`payload.zip`	`string`	No	—	A 5 digit US ZIP Code
`payload.country`	`string`	No	—	A 2 letter country abbreviation
`payload.phone`	`string`	No	—	A valid 10 digit North American phone number
`payload.domain`	`string`	No	—	A business domain
`payload.business`	`string`	No	—	A business name
`payload.li_url`	`string`	No	—	A valid LinedIn URL
`payload.email`	`string`	No	—	A valid consumer or business email address
`payload.cfg_maxrecs`	`integer`	No	`1`	Number of records to return, from 1 through 100 Minimum: 1. Maximum: 100.
`payload.rcfg_max_time`	`number`	No	—	Maximum allowed API runtime in seconds Minimum: 0.
`payload.rcfg_oa_services`	`array`	No	—	Online audience services to return. Defaults to all services

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Raw Versium REACH response.
`result.data.versium`	`object`	Yes	—	—
`result.data.versium.version`	`string`	Yes	—	—
`result.data.versium.match_counts`	`record`	No	—	—
`result.data.versium.num_matches`	`integer`	Yes	—	Minimum: 0.
`result.data.versium.num_results`	`integer`	Yes	—	Minimum: 0.
`result.data.versium.query_id`	`string`	Yes	—	—
`result.data.versium.query_time`	`number`	Yes	—	Minimum: 0.
`result.data.versium.results`	`array`	Yes	—	—
`result.data.versium.input_query`	`record`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: per_result (per result).
Estimated Deepline credits: 0.7 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation