resources/segments/search/profiles/presets

Permits to retrieve presets filters depending on the current scope.




URL

(POST) /api/resources/segments/search/profiles/presets

PARAMETERS

The message body contains a JSON object with these properties.

scope

The scope object. It delimits the total range of segments and related resources that can be queried.

Example:

"scope": { "type": "Project", "projectid": 1234 }

Mandatory, object
locale

String representation of the locale

Mandatory, string
query

The query object. It is used to limit results to a certain portion of the scope.

See resources/segments/search for details on this object.

Mandatory, object


RESULTS

Returns an array of JSON objects, each object with this structure:

key

Identifier for the preset.

string
name

The preset name.

string
count

Number of segments matching the preset.

int
dataOptional additional datastring
query

The query object that is linked to the preset.

See resources/segments/search for details on this object.

object


EXAMPLE

N/A

Copyright Wordbee - Buzzin' Outside the Box since 2008