POST datastore/schemas/:schema name/objects/search
(Difference between revisions)
Renato.neves (Talk | contribs) (Created page with "== Description == Searches for Objects in the Schema. == Resource URL == POST https://api.socialidnow.com/v1/marketing/datastore/schemas/:schema_name/objects/search == ...") |
Renato.neves (Talk | contribs) (→Parameters) |
||
Line 15: | Line 15: | ||
| width="200px" | required | | width="200px" | required | ||
| schema name. | | schema name. | ||
+ | |} | ||
+ | |||
+ | === JSON Parameters === | ||
+ | |||
+ | {| | ||
+ | ! align="left" width="200px" | stages | ||
+ | | width="200px" | optional | ||
+ | | a hash in the format stage:value | ||
+ | |- | ||
+ | ! align="left" width="200px" | match | ||
+ | | width="200px" | optional | ||
+ | | a match stage | ||
+ | |- | ||
+ | ! align="left" width="200px" | group | ||
+ | | width="200px" | optional | ||
+ | | a group stage | ||
+ | |- | ||
+ | ! align="left" width="200px" | sort | ||
+ | | width="200px" | optional | ||
+ | | a sort stage | ||
+ | |- | ||
+ | ! align="left" width="200px" | project | ||
+ | | width="200px" | optional | ||
+ | | a project stage | ||
+ | |- | ||
+ | ! align="left" width="200px" | skip | ||
+ | | width="200px" | optional | ||
+ | | a skip stage | ||
+ | |- | ||
+ | ! align="left" width="200px" | limit | ||
+ | | width="200px" | optional | ||
+ | | a limit stage | ||
|} | |} | ||
Revision as of 16:26, 22 September 2015
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. |
---|
JSON Parameters
stages | optional | a hash in the format stage:value |
---|---|---|
match | optional | a match stage |
group | optional | a group stage |
sort | optional | a sort stage |
project | optional | a project stage |
skip | optional | a skip stage |
limit | optional | a limit stage |
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 }, { ... } ] }