POST database/people/search

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 +
<span style="color: red; font-weight: bold">Deprecation notice:</span> this API will be deprecated on December 21, 2018.
 +
 
== Description ==
 
== Description ==
  

Revision as of 15:26, 9 November 2018

Deprecation notice: this API will be deprecated on December 21, 2018.

Contents

Description

This API allows searching for contacts in the Marketing Database.

See search fields page for further details on query specification.

This API also returns the full profile from users that match the search criteria. An optional field "fields" can be used to specify which profile fields to return.

Resource URL

  POST https://api.socialidnow.com/v1/marketing/database/people/search

Parameters

JSON Parameters

filters required SQL-like logical expression to specify search filters.
limit optional maximum amount of results to be returned (page size). Default: 128.
offset optional amount of results to be discarded (page start). Default: 0.
fields optional a list of user profile field names to be returned, joined by commas. See Social Profile Fields.

Authentication

This API requires Marketing Account authentication. See Authentication.

Response

Response Status

ok (200) The search was performed successfully.
unauthorized (401) The authentication is wrong. See Authentication.
internal_server_error (500) An unknown error happened.

Response Body

A successful search returns the following fields:

total total amount of contacts found in the Marketing Database for the given query.
count amount of contacts returned for this request.
offset amount of contacts discarded (page start).
results array with contact details. See Social Profile Fields for the complete list of returned fields.

Examples

Request

Search for users named "Guilherme".

 curl -X POST "https://api.socialidnow.com/v1/marketing/database/people/search" \
       --data "{\"filters\": \"profile.name.given_name = 'Guilherme'\"}" \
       -H "Content-type: application/json" \
       --user <api_id>:<api_secret>

Response

Response Headers

HTTP/1.1 200 Ok
Status: 200

Response Body

 {
    "total": 13,
    "count": 13,
    "offset": 0,
    "results": [...]
 }

Search results.png

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox