Get Grouped Exchanges Api

curl --request GET \
  --url https://services.meetchase.ai/api/v1/campaigns/data/replies \
  --header 'X-API-Key: <api-key>'

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

fetch('https://services.meetchase.ai/api/v1/campaigns/data/replies', 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://services.meetchase.ai/api/v1/campaigns/data/replies",
  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://services.meetchase.ai/api/v1/campaigns/data/replies"

	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://services.meetchase.ai/api/v1/campaigns/data/replies")

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

[
  {
    "id": 123,
    "campaign_id": 123,
    "updated_at": "2023-11-07T05:31:56Z",
    "contact": {
      "email": "jsmith@example.com",
      "id": 123,
      "organisation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "bot": {
      "email": "jsmith@example.com",
      "id": 123,
      "organisation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
]

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

Campaigns

Fetch Contact Status

This endpoint fetches exchange data, which represents a conversation between a bot and a contact. It can be filtered by campaign, a date range, and the type of exchange (e.g., positive replies vs. meetings booked).

Query Parameters

campaign_id (int, optional): The ID of a specific campaign to filter by. If omitted, exchanges from all campaigns are returned.
start_date (str, optional): The start of the date range for filtering exchanges, in YYYY-MM-DD format. Defaults to 2023-01-01.
end_date (str, optional): The end of the date range for filtering exchanges, in YYYY-MM-DD format. Defaults to the current date.
exchange_group (str, optional): The category of exchanges to retrieve. Defaults to "replied". Possible values: "replied", "meeting-booked".

Headers

X-API-Key: The API key for authenticating the request.

Response

Returns a JSON array of BaseExchange objects.

GET

api

campaigns

data

replies

Get Grouped Exchanges Api

curl --request GET \
  --url https://services.meetchase.ai/api/v1/campaigns/data/replies \
  --header 'X-API-Key: <api-key>'

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

fetch('https://services.meetchase.ai/api/v1/campaigns/data/replies', 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://services.meetchase.ai/api/v1/campaigns/data/replies",
  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://services.meetchase.ai/api/v1/campaigns/data/replies"

	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://services.meetchase.ai/api/v1/campaigns/data/replies")

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

[
  {
    "id": 123,
    "campaign_id": 123,
    "updated_at": "2023-11-07T05:31:56Z",
    "contact": {
      "email": "jsmith@example.com",
      "id": 123,
      "organisation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    },
    "bot": {
      "email": "jsmith@example.com",
      "id": 123,
      "organisation": "<string>",
      "first_name": "<string>",
      "last_name": "<string>"
    }
  }
]

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

Authorizations

X-API-Key

string

header

required

Key used to authenticate user API requests.

Query Parameters

campaign_id

integer | null

start_date

string<date> | null

end_date

string<date> | null

exchange_group

enum<string>

default:replied

Available options:

replied,

meeting-booked

Response

Successful Response

integer

required

campaign_id

integer

required

updated_at

string<date-time>

required

contact

Correspondent · object

required

Show child attributes

Example:

{
  "email": "guido@example.com",
  "first_name": "Guido",
  "id": 1,
  "last_name": "van Rossum",
  "organisation": "Microsoft"
}

bot

Correspondent · object

required

Show child attributes

Example:

{
  "email": "guido@example.com",
  "first_name": "Guido",
  "id": 1,
  "last_name": "van Rossum",
  "organisation": "Microsoft"
}

status

enum<string>

required

Available options:

OUTREACH_PENDING,

OUTREACH_QUEUED,

OUTREACH_ACTIVE,

NO_RESPONSE,

INVALID_ADDRESS,

FAILED_DELIVERY,

UNSUB_LINK,

UNSUB_REQUEST,

DECLINED,

FOLLOWUP_LATER,

FOLLOWUP_SENT,

PROVIDED_REFERRAL,

OUTREACH_REFERRAL,

SCHEDULING_MEETING,

INFO_INQUIRY,

AWAITING_REPLY,

NURTURING,

MEETING_BOOKED,

OTHER_CONVERSION

API Documentation

Campaigns

Meetings & Conversions

Contacts

AI SDRs

Fetch Contact Status

Query Parameters

Headers

Response

Authorizations

Query Parameters

Response