Perform a search

Unstable

Field	Type	Required / Optional	Description / Notes
`from`	Integer	Optional	The result set offset. Default `0`. Minimum `0`.
`size`	Integer	Optional	The maximum results to return. Default `100`. Maximum `100`.
`query`	Object	Required
document field path	Object	Required	Path: allowed characters: `a-z`, `*`, and `.` E.g. `attributes.name` At least one sub-object is required.
`exists`	Boolean		The field's existence in the document. A `null` value for a field would not exist in the document.
`range`	Object		At least one sub-object is required.
`gt`	Integer		Greater than the supplied value, non-inclusive.
`gte`	Integer		Greater than or equal to the supplied value.
`lt`	Integer		Less than the supplied value, non-inclusive.
`lte`	Integer		Less than or equal to the supplied value.
`value`	String		The value to use for the search query.
`value_operator`	String		Boolean logic used to interpret terms in the query `value`. Allowed values: `AND`, `OR`. Default value: `AND`. May only be used in-conjuntion with `value` queries.
`sort`	Array, Object	Optional	Order in which to sort results. Default `100`. Maximum `100`.
document field path	String	Required	Path: allowed characters: `a-z`, and `.` E.g. `attributes.display_name` Values: `asc`, `desc`
`resource_types`	Array, String	Optional	The resource types to query. Values: Searchable resource types.

POST  /search

curl https://reactor.adobe.io/search \
  -H "Accept: application/vnd.api+json;revision=1" \
  -H "Content-Type: application/vnd.api+json" \
  -H "Authorization: Bearer [TOKEN]" \
  -H "X-Api-Key: [KEY]" \
  -H "X-Gw-Ims-Org-Id: [ORG_ID]" \
  -X POST \
  -d \
'
{
  "data": {
    "query": {
      "attributes.name": {
        "value": "Example"
      }
    }
  }
}'

200 OK

{
  "data": [
    {
      "id": "PR2327712414f942e19c5015ea0e37e0d4",
      "type": "properties",
      "attributes": {
        "created_at": "2022-02-04T21:23:24.471Z",
        "enabled": true,
        "name": "Kessel Example Property",
        "updated_at": "2022-02-04T21:23:24.471Z",
        "platform": "web",
        "development": false,
        "token": "4bf8249a6f8e",
        "domains": [
          "example.com"
        ],
        "undefined_vars_return_empty": false,
        "rule_component_sequencing_enabled": true
      },
      "relationships": {
        "company": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/company"
          },
          "data": {
            "id": "CO242a7461b61b4ce8831633b3e1dddcb9",
            "type": "companies"
          }
        },
        "callbacks": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/callbacks"
          }
        },
        "hosts": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/hosts"
          }
        },
        "environments": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/environments"
          }
        },
        "libraries": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/libraries"
          }
        },
        "data_elements": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/data_elements"
          }
        },
        "extensions": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/extensions"
          }
        },
        "rules": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/rules"
          }
        },
        "notes": {
          "links": {
            "related": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/notes"
          }
        }
      },
      "links": {
        "company": "https://reactor.adobe.io/companies/CO242a7461b61b4ce8831633b3e1dddcb9",
        "data_elements": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/data_elements",
        "environments": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/environments",
        "extensions": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/extensions",
        "rules": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4/rules",
        "self": "https://reactor.adobe.io/properties/PR2327712414f942e19c5015ea0e37e0d4"
      },
      "meta": {
        "match_score": 3.1645029
      }
    }
  ],
  "meta": {
    "total_hits": 1
  }
}

Perform a search

Structure

Endpoint Definition

Example Request

Example Response