Summarize activity - TalkToHumans

GET

https://api.talktohumans.app

activity

summary

Summarize activity

curl --request GET \
  --url https://api.talktohumans.app/v1/activity/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.talktohumans.app/v1/activity/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.talktohumans.app/v1/activity/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.talktohumans.app/v1/activity/summary"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "generated_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "totals": {
      "events": 123,
      "unattributed_user_events": 123,
      "unattributed_account_events": 123
    },
    "by_event_type": [
      {
        "count": 123,
        "key": "<string>",
        "missing": true
      }
    ],
    "by_channel": [
      {
        "count": 123,
        "key": "<string>",
        "missing": true
      }
    ],
    "by_source": [
      {
        "count": 123,
        "key": "<string>",
        "missing": true
      }
    ],
    "by_user": [
      {
        "count": 123,
        "id": "<string>",
        "unattributed": true
      }
    ],
    "by_account": [
      {
        "count": 123,
        "id": "<string>",
        "unattributed": true
      }
    ],
    "by_template": [
      {
        "template_key": "<string>",
        "template_public_id": "<string>",
        "outreach_runs_started": 123,
        "outreach_runs_replied": 123,
        "reply_rate": 0.5,
        "connection_requests_sent": 123,
        "connection_requests_accepted": 123,
        "connection_request_acceptance_rate": 0.5
      }
    ],
    "template_metrics_basis": "<string>",
    "metrics": {
      "contacts_contacted_outbound": 123,
      "contacts_replied_to_outbound": 123,
      "reply_rate": 0.5,
      "connection_requests_sent": 123,
      "connection_requests_accepted": 123,
      "connection_request_acceptance_rate": 0.5,
      "basis": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Pass API key as Authorization: Bearer <api_key>.

Query Parameters

from

string

Inclusive activity window start. Use RFC3339 or YYYY-MM-DD. Date-only values are interpreted in the requested timezone.

string

Exclusive activity window end. Use RFC3339 or YYYY-MM-DD. Date-only values are interpreted in the requested timezone and advance to the start of the following local day. The response repeats the normalized instant in filters.to with to_exclusive: true.

timezone

string

default:UTC

IANA timezone used for date-only from and to filters. Defaults to UTC.

account_id

string[]

Filter by TalkToHumans LinkedIn account ID in activity facts. Repeat the query parameter for multiple accounts. The backend also accepts comma-separated values.

Pattern: ^[1-9][0-9]*$

user_id

string[]

Filter by TalkToHumans user ID in activity facts. Repeat the query parameter for multiple users. The backend also accepts comma-separated values.

Pattern: ^[1-9][0-9]*$

event_type

enum<string>[]

Filter by activity event type. Repeat the query parameter for multiple event types. The backend also accepts comma-separated values.

Available options:

connection_request_sent,

connection_request_accepted,

incoming_connection_request_accepted,

message_scheduled,

message_sent,

follow_up_sent,

message_received,

outbound_reply_received,

template_run_started,

template_run_replied

channel

string[]

Filter by activity channel, such as linkedin_message, linkedin_inmail, or linkedin_connection. Repeat the query parameter for multiple channels. The backend also accepts comma-separated values.

source

string[]

Filter by activity emitter source, such as canonical_messages, canonical_chats, canonical_sequence_steps, sequence_runner_report, or canonical_account_participants. Repeat the query parameter for multiple sources. The backend also accepts comma-separated values.

tag

string

Reserved for future tag-attributed reporting. Passing this parameter currently returns 400 bad_request.

Response

Activity summary.

data

object

required

Show child attributes

List activityLists activity events for the current organization.

Summarize activity

curl --request GET \
  --url https://api.talktohumans.app/v1/activity/summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.talktohumans.app/v1/activity/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.talktohumans.app/v1/activity/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.talktohumans.app/v1/activity/summary"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "generated_at": "2023-11-07T05:31:56Z",
    "timezone": "<string>",
    "totals": {
      "events": 123,
      "unattributed_user_events": 123,
      "unattributed_account_events": 123
    },
    "by_event_type": [
      {
        "count": 123,
        "key": "<string>",
        "missing": true
      }
    ],
    "by_channel": [
      {
        "count": 123,
        "key": "<string>",
        "missing": true
      }
    ],
    "by_source": [
      {
        "count": 123,
        "key": "<string>",
        "missing": true
      }
    ],
    "by_user": [
      {
        "count": 123,
        "id": "<string>",
        "unattributed": true
      }
    ],
    "by_account": [
      {
        "count": 123,
        "id": "<string>",
        "unattributed": true
      }
    ],
    "by_template": [
      {
        "template_key": "<string>",
        "template_public_id": "<string>",
        "outreach_runs_started": 123,
        "outreach_runs_replied": 123,
        "reply_rate": 0.5,
        "connection_requests_sent": 123,
        "connection_requests_accepted": 123,
        "connection_request_acceptance_rate": 0.5
      }
    ],
    "template_metrics_basis": "<string>",
    "metrics": {
      "contacts_contacted_outbound": 123,
      "contacts_replied_to_outbound": 123,
      "reply_rate": 0.5,
      "connection_requests_sent": 123,
      "connection_requests_accepted": 123,
      "connection_request_acceptance_rate": 0.5,
      "basis": "<string>"
    }
  }
}