Skip to main content
POST
/
companies
/
advertisements
/
export
Export advertisements
curl --request POST \
  --url https://api.pubrio.com/companies/advertisements/export \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "companies": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "domains": [
    "pubrio.com"
  ],
  "exclude_fields": [
    "emails",
    "phones",
    "contacts"
  ],
  "exclude_data_export_fields": [
    "raw_html"
  ],
  "profile_id": 123
}
'
import requests

url = "https://api.pubrio.com/companies/advertisements/export"

payload = {
    "companies": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "domains": ["pubrio.com"],
    "exclude_fields": ["emails", "phones", "contacts"],
    "exclude_data_export_fields": ["raw_html"],
    "profile_id": 123
}
headers = {
    "pubrio-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    companies: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    domains: ['pubrio.com'],
    exclude_fields: ['emails', 'phones', 'contacts'],
    exclude_data_export_fields: ['raw_html'],
    profile_id: 123
  })
};

fetch('https://api.pubrio.com/companies/advertisements/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.pubrio.com/companies/advertisements/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'companies' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'domains' => [
        'pubrio.com'
    ],
    'exclude_fields' => [
        'emails',
        'phones',
        'contacts'
    ],
    'exclude_data_export_fields' => [
        'raw_html'
    ],
    'profile_id' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "pubrio-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pubrio.com/companies/advertisements/export"

	payload := strings.NewReader("{\n  \"companies\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"domains\": [\n    \"pubrio.com\"\n  ],\n  \"exclude_fields\": [\n    \"emails\",\n    \"phones\",\n    \"contacts\"\n  ],\n  \"exclude_data_export_fields\": [\n    \"raw_html\"\n  ],\n  \"profile_id\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("pubrio-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.pubrio.com/companies/advertisements/export")
  .header("pubrio-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companies\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"domains\": [\n    \"pubrio.com\"\n  ],\n  \"exclude_fields\": [\n    \"emails\",\n    \"phones\",\n    \"contacts\"\n  ],\n  \"exclude_data_export_fields\": [\n    \"raw_html\"\n  ],\n  \"profile_id\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.pubrio.com/companies/advertisements/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"companies\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"domains\": [\n    \"pubrio.com\"\n  ],\n  \"exclude_fields\": [\n    \"emails\",\n    \"phones\",\n    \"contacts\"\n  ],\n  \"exclude_data_export_fields\": [\n    \"raw_html\"\n  ],\n  \"profile_id\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {}
  ]
}

Authorizations

pubrio-api-key
string
header
required

A unique API token that represents the actions you perform through the API and the corresponding permissions and operations. You can create it through the Settings section.

Body

application/json
companies
string<uuid>[]
required

A list of unique identifiers (domain_search_id) used for company and people search operations.

domains
string[]

List of company domains used for company and people search operations. If we receive a URL such as www.pubrio.com or https://docs.pubrio.com/, the system will convert it to pubrio.com for processing.

Example:
["pubrio.com"]
exclude_fields
string[]

List of fields to exclude from the response payload.

Example:
["emails", "phones", "contacts"]
exclude_data_export_fields
string[]

Columns to omit from the generated export file (separate from exclude_fields, which removes fields from each record).

Example:
["raw_html"]
profile_id
integer

Optional. An identifier for the user profile (workspace) making the request. This is no longer required as the API key already includes your workspace information. If provided, it helps in associating the lookup with a specific user, allowing for data retrieval and credit tracking.

Check out user details endpoints under the Profile tab for more information.

Response

200 - application/json

The exported records. Charged against your data_export_credit balance.

data
object[]

Exported records, with exclude_fields removed.