LogoLogo
WebsiteGuide & TutorialBlogBook a Demo
1.0.0
1.0.0
  • Acquire Developers Hub
  • Acquire
    • Acquire Build Requirement
      • Requirement For Acquire
      • Acquire Speedtest
  • JS API
    • JS Live Chat API
      • Description
      • Installation
      • Visitor
      • Thread
      • Conversation
      • User Verification
    • Quick Link Support
      • One Click Button
      • Social Media Share
    • Backend JS SDK
      • Setup Backend JS SDK
      • Demo Backend SDK
    • Advanced
      • Widget UI
      • Reference
  • Co Browse APIs
    • Acquire Co Browse
      • Co Browse API
  • Acquire API Events
    • WebRTC Related Events
  • iOS
    • SDK Setup Guide
      • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Manual Setup iOS
      • Acquire Account ID
    • SDK Configuration Example
    • iOS Cobrowse
    • Theme Setting
    • iOS Push Notifications
    • Verify your users
  • Android
    • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Start using Acquire
    • Acquire APIs
    • Acquire Delegates
    • Custom UI/widget
    • Cross Platform Integrations
  • Webhook API
    • Webhooks Basic
      • Introduction
      • Webhook Integrate Steps
      • Webhook Format
    • Webhook Events
      • On Chat Start
      • On Chat Accept
      • On Chat Message
      • On Chat Close
  • REST APIs
    • OAuth
      • Authorization
      • Tracklog
    • Profiles API
      • Profile List
      • Thread
      • Feedback
      • Profile Details
      • Message
      • Tags
      • Profile Agents
      • Campaigns
      • Profile Add Update
      • Profile Delete
      • Profile Visit History
      • Sender Emails
    • Chat
      • Chat Notes
    • Analytics
      • Chat Statistics
      • Team Analytics
      • Conversion Rate
      • Chat Tag
      • Co browsing
    • Agent
      • Agents List
      • Agent add
      • Edit / Get-agent
      • Update
    • Trigger
      • Triggers List
      • Triggers Detail
    • Operating Hours
      • Save Operating Hours
      • Get Operating Hours
    • Cobrowse
  • Chatbot API
    • Chat Bot
      • Integrate Your Chatbot
      • Dialog Flow V1 Chat-Bot
      • Dialog Flow V2 Chat-Bot
      • Dialog Flow Fulfillment & Custom Response
      • IBM Watson Integration
      • Amazon Lex Bot
      • Azure's QnA Maker
      • Webhook Calling & User Verification
      • Webhook For Reset Password
  • Knowledge Base APIs
    • Help Docs Setup
      • Get FAQ Categories
      • Get Setup Details
      • Get Side List
      • Get Article
      • Get Recent Article
      • Get Categorized Articles
      • Get Suggestion
  • Errors
    • API Error Handling
      • HTTP Responses
Powered by GitBook
On this page
  1. REST APIs
  2. Profiles API

Profile List

Acquire live chat dashboard gives your team leader an overview of agent activity at any given time.

Profiles List API body parameter in add limit, page and filter[master]

Profiles Use

Parameter

Value

Path

https://app.acquire.io/api/profile/lead/list

Method

POST

Authorization

Bearer YOUR_API_AUTH_TOKEN

Content-type

application/x-www-form-urlencode

zone

{"timezone":"Pacific/California","offset":"-08:00"}

Parameter

Value

limit

10

page

1

filter[master]

chathistory (Optional)

Response JSON Format


{
    "success": true,
    "error": null,
    "data": {
        "total": 1,
        "data": [
            {
                "id": 70574,
                "session_id": 70574,
                "checked_status": 0,
                "visitor_id": 70574,
                "source": null,
                "name": "",
                "email": "",
                "visitor_phone": "",
                "location_full_name": "San Francisco, California, United States",
                "ip": "",
                "country_name": "United States",
                "timezone": "America/Yakutat",
                "country_code": "USA",
                "date_updated": "2018-08-02 07:30:28",
                "city": "517",
                "browser_language": "",
                "conversion": "",
                "first_seen": null,
                "last_seen": null,
                "lead_id": 0,
                "chat_id": ,
                "recording_available": null,
                "rating": null,
                "chat_updated": "2018-08-02 07:31:02",
                "chat_created": "2018-08-02 07:30:28",
                "chat_date_created": null,
                "chat_date_updated": null,
                "ua": "Chrome,,Mac,,Desktop,,,WebKit",
                "browser_name": "Chrome",
                "browser_version": "",
                "os_name": "Mac OS",
                "os_version": "",
                "tags": "",
                "agent_name": "John Deo",
                "bg_color": "#4a1271"
            }
        ],
        "main_query_time": 0.006,
        "chat_user_query_time": 0.003,
        "notify_query_time": 0.011,
        "tag_query_time": 0.002,
        "overall_time": 0.022
    }
}

Sample Code

var qs = require("querystring");
	var http = require("http");

	var options = {
		"method": "POST",
		"hostname": [
			"app",
			"acquire",
			"io"
		],
		"path": [
			"profile",
			"lead",
			"list"
		],
		"headers": {
			"Authorization: Bearer [YOUR_API_AUTH_TOKEN]",
			"Content-Type": "application/x-www-form-urlencoded"
		}
	};

	var req = http.request(options, function (res) {
	var chunks = [];

	res.on("data", function (chunk) {
		chunks.push(chunk);
	});

	res.on("end", function () {
    var body = Buffer.concat(chunks);
		console.log(body.toString());
		});
	});

	req.write(qs.stringify({ limit: '50', page: '1', 'filter[master]': 'chathistory' }));
	req.end();
$curl = curl_init();

	curl_setopt_array($curl, array(
		CURLOPT_URL => "http://app.acquire.io/profile/lead/list",
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_ENCODING => "",
		CURLOPT_MAXREDIRS => 10,
		CURLOPT_TIMEOUT => 30,
		CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
		CURLOPT_CUSTOMREQUEST => "POST",
		CURLOPT_POSTFIELDS => "limit=50&page=1&filter%5Bmaster%5D=chathistory",
		CURLOPT_HTTPHEADER => array(
			"Authorization: Bearer [YOUR_API_AUTH_TOKEN]",
			"Content-Type: application/x-www-form-urlencoded"
		),
	));

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

	curl_close($curl);

	if ($err) {
		echo "cURL Error #:" . $err;
	} else {
		echo $response;
	}
 require 'uri'
	require 'net/http'

	url = URI("http://app.acquire.io/profile/lead/list")

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

	request = Net::HTTP::Post.new(url)
	request["Authorization"] = 'Bearer [YOUR_API_AUTH_TOKEN]'
	request["Content-Type"] = 'application/x-www-form-urlencoded'
	request.body = "limit=50&page=1&filter%5Bmaster%5D=chathistory"

	response = http.request(request)
	puts response.read_body
curl --request POST \
		--url 'http://app.acquire.io/profile/lead/list' \
		--header 'Authorization: Bearer [YOUR_API_AUTH_TOKEN]' \
		--header 'Content-Type: application/x-www-form-urlencoded' \
		--data 'limit=50&page=1&filter%5Bmaster%5D=chathistory'
var settings = {
		"async": true,
		"crossDomain": true,
		"url": "http://app.acquire.io/profile/lead/list",
		"method": "POST",
		"headers": {
				"Authorization: Bearer [YOUR_API_AUTH_TOKEN]"
				"Content-Type": "application/x-www-form-urlencoded"
			},
		"data": {
			"limit": "50",
			"page": "1",
			"filter[master]": "chathistory"
		}
	}

	$.ajax(settings).done(function (response) {
		console.log(response);
	});
import requests

		url = "http://app.acquire.io/profile/lead/list"

		payload = "limit=50&page=1&filter%5Bmaster%5D=chathistory"
		headers = {'Authorization: Bearer [YOUR_API_AUTH_TOKEN]','Content-Type': 'application/x-www-form-urlencoded'}

		response = requests.request("POST", url, data=payload, headers=headers)

		print(response.text)
PreviousProfiles APINextThread

Last updated 4 years ago