Get a report

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/reports \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/reports', 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.b2bsignals.ai/api/v1/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.b2bsignals.ai/api/v1/reports"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/reports")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "range": {
    "key": "7d",
    "from_date": "2023-12-25",
    "to_date": "2023-12-25",
    "label": "<string>"
  },
  "group_by": "signal",
  "insight": {
    "headline": "<string>",
    "detail": "<string>",
    "focus_key": "<string>",
    "state": "normal",
    "action": {
      "label": "<string>",
      "target": "sources"
    }
  },
  "numbers": {
    "people_contacted": 0,
    "replied": 0,
    "meetings_booked": 0
  },
  "funnel": {
    "caption": "<string>",
    "steps": [
      {
        "key": "contacted",
        "label": "<string>",
        "count": 123,
        "pct_of_contacted": 123
      }
    ]
  },
  "generated_at": "2023-11-07T05:31:56Z",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_name": "<string>",
  "rows": [
    {
      "key": "<string>",
      "label": "<string>",
      "contacted": 123,
      "replied": 123,
      "interested_replies": 123,
      "meetings": 123,
      "comparison": "much_more",
      "enough_data": true,
      "reply_rate": 123,
      "note": "<string>",
      "position": 123
    }
  ],
  "people": [
    {
      "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "got_so_far": "<string>",
      "what_happened": "<string>",
      "outcome": "meeting",
      "first_contacted": "2023-12-25",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "company": "<string>",
      "sender": "<string>",
      "last_touch": "2023-12-25"
    }
  ],
  "people_total": 123,
  "average_reply_rate": 123,
  "min_people_for_rate": 50,
  "mature_after_days": 7,
  "workspace_name": "<string>",
  "group_by_options": [
    {
      "key": "signal",
      "label": "<string>",
      "needs_campaign": false,
      "shareable": true
    }
  ],
  "sender_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_name": "<string>",
  "daily_sends": [
    {
      "date": "<string>",
      "connections_sent": 0,
      "connections_accepted": 0,
      "messages_sent": 0,
      "message_replies": 0
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

reports

Get a report

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/reports \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/reports', 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.b2bsignals.ai/api/v1/reports",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.b2bsignals.ai/api/v1/reports"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/reports")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "range": {
    "key": "7d",
    "from_date": "2023-12-25",
    "to_date": "2023-12-25",
    "label": "<string>"
  },
  "group_by": "signal",
  "insight": {
    "headline": "<string>",
    "detail": "<string>",
    "focus_key": "<string>",
    "state": "normal",
    "action": {
      "label": "<string>",
      "target": "sources"
    }
  },
  "numbers": {
    "people_contacted": 0,
    "replied": 0,
    "meetings_booked": 0
  },
  "funnel": {
    "caption": "<string>",
    "steps": [
      {
        "key": "contacted",
        "label": "<string>",
        "count": 123,
        "pct_of_contacted": 123
      }
    ]
  },
  "generated_at": "2023-11-07T05:31:56Z",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workflow_name": "<string>",
  "rows": [
    {
      "key": "<string>",
      "label": "<string>",
      "contacted": 123,
      "replied": 123,
      "interested_replies": 123,
      "meetings": 123,
      "comparison": "much_more",
      "enough_data": true,
      "reply_rate": 123,
      "note": "<string>",
      "position": 123
    }
  ],
  "people": [
    {
      "lead_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "got_so_far": "<string>",
      "what_happened": "<string>",
      "outcome": "meeting",
      "first_contacted": "2023-12-25",
      "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "company": "<string>",
      "sender": "<string>",
      "last_touch": "2023-12-25"
    }
  ],
  "people_total": 123,
  "average_reply_rate": 123,
  "min_people_for_rate": 50,
  "mature_after_days": 7,
  "workspace_name": "<string>",
  "group_by_options": [
    {
      "key": "signal",
      "label": "<string>",
      "needs_campaign": false,
      "shareable": true
    }
  ],
  "sender_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sender_name": "<string>",
  "daily_sends": [
    {
      "date": "<string>",
      "connections_sent": 0,
      "connections_accepted": 0,
      "messages_sent": 0,
      "message_replies": 0
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your workspace's API key. It starts with b2b_sk_.

Query Parameters

range

enum<string>

default:30d

The period to report on. custom needs from and to.

Available options:

7d,

30d,

90d,

custom

from

string<date> | null

group_by

enum<string>

default:signal

How to group the report's rows.

Available options:

signal,

source,

campaign,

sender,

week,

step,

version,

person

workflow_id

string<uuid> | null

Only this campaign.

sender_id

string<uuid> | null

Only this sender.

include

string | null

Response

Success

range

object

required

Show child attributes

group_by

enum<string>

required

Available options:

signal,

source,

campaign,

sender,

week,

step,

version,

person

insight

object

required

Show child attributes

numbers

object

required

Show child attributes

funnel

object

required

Show child attributes

generated_at

string<date-time>

required

workflow_id

string<uuid> | null

workflow_name

string | null

rows

object[]

Show child attributes

people

object[] | null

Show child attributes

people_total

integer | null

average_reply_rate

number | null

min_people_for_rate

integer

default:50

mature_after_days

integer

default:7

workspace_name

string | null

group_by_options

object[]

Show child attributes

sender_id

string<uuid> | null

sender_name

string | null

daily_sends

object[] | null

Show child attributes

Build on B2B Signals

API reference

Get a report

Authorizations

Query Parameters

Response