POST datastore/schemas/:schema name/objects/search
From Social ID Developers
Revision as of 16:14, 22 September 2015 by Renato.neves (Talk | contribs)
Contents |
Description
Searches for Objects in the Schema.
Resource URL
POST https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects/search
Parameters
URL Parameters
schema_name | required | schema name. |
---|
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. |
not_found (404) | The schema was not found. |
internal_server_error (500) | An unknown error happened. |
Response Body
A successful search returns the following fields:
total | total amount of objects found. |
---|---|
count | amount of objects returned in this page. |
offset | amount of discarded objects (page start). |
results | array with object details. |
Examples
Request
Returns all objects from the schema named "my_schema" which have the attribute "email" present:
curl -iX POST 'https://api.socialidnow.com/v1/marketing/datastore/schemas/my_schema/objects/search' \ -d "{\"match\":{\"email\":{\"\$exists\":true}}}" \ -H 'Content-type: application/json' \ --user 138:e8b9ca24f1b590af67e6271297d6e1f7226625d61c5b5daa1b2f215464e292cf
Response
Response Headers
HTTP/1.1 200 Ok Status: 200
Response Body
{ "total": 2, "count": 2, "offset": 0, "results": [ { "object_id": "54481188e5cb7cffe4000003", "user_id": 340, "created_at": "2014-10-24T14:48:00Z", "updated_at": "2014-10-24T14:48:00Z", "email": "john@example.com", "second_field": 123 }, { ... } ] }