Analysis Compare

get

https://api.qloo.com/v2/analysis/compare

Analyze and compare two groups of entities.

Query Params

a.signal.interests.entities

array of strings

required

The first group of entities to base the comparison on.

a.signal.interests.entities*

b.signal.interests.entities

array of strings

required

The second group of entities to base the comparison on.

b.signal.interests.entities*

filter.type

array of strings

The category to search against.

filter.type

filter.entities.query

string

A query string used to search for entity IDs to filter results. This allows
you to supply a human-readable term which the system resolves to one or more
matching entity identifiers.

filter.exclude.entities.query

array

This parameter can only be supplied when using POST HTTP method, since it requires JSON encoded body.
The value for filter.exclude.entities.query is a JSON array with objects containing the name and address properties.
For a fuzzier search, just include an array of strings.
When supplied, it overwrites the filter.exclude.entities object with resolved entity IDs.
The response will contain a path query.entities.exclude, with partial Qloo entities that were matched by the query.
If no entities are found, the API will throw a 400 error.

filter.exclude.entities.query

filter.location.query

A text-based name lookup used to search for one or more named urn:entity:locality Qloo IDs for filtering requests. This parameter performs fuzzy text matching only — it will not work with a UUID or Qloo entity ID. To pass a locality ID directly, use filter.location instead.

For GET requests: Provide a single locality query as a string.
For POST requests:
- You can still send a single locality as a string.
- Or you can send an array of locality names to query multiple localities
  at once. When multiple localities are provided, their geographic shapes are merged, and the system returns results with the highest affinities across the combined area.
  Locality queries are fuzzy-matched and case-insensitive. Examples include New York City, Garden City, New York, Los Angeles, Lower East Side, and AKAs like The Big Apple. When a single locality is supplied, the response JSON includes query.locality.signal with the matched Qloo entity. If multiple are supplied, this field is omitted. By default, the API includes a tuning that also captures nearby entities just outside the official boundaries of the locality. To turn this off and limit results strictly to within the locality, set filter.location.radius=0. If no localities are found, the API returns a 400 error.

filter.location.radius

integer

≤ 800000

Defaults to 15000

Filter by the radius (in meters) when also supplying filter.location or filter.location.query.
When a locality is passed via filter.location or filter.location.query and this parameter is not provided, the API expands the locality boundary by the lesser of 10% of the locality's diameter or 2,414 meters (~1.5 miles).
Setting this parameter to 0 disables this padding and restricts results strictly to within the locality boundary.
A larger value pads the boundary by that radius in meters.

filter.exclude.location.query

A query used to exclude results based on one or more named urn:entity:locality Qloo IDs, resolved from fuzzy-matched locality names. This is equivalent to passing the resolved Locality Qloo ID(s) into filter.exclude.location.

For GET requests: Provide a single locality query as a string. - For POST requests:
- You can still send a single locality as a string.
- Or send an array of locality names to exclude multiple areas at once. When
  multiple localities are provided, their geographic shapes are merged, and the system excludes results from across the combined area.
  Locality queries are case-insensitive and support common AKAs (e.g., The Big Apple for New York). When a single locality is supplied, the response includes query.locality.exclude.signal with the matched Qloo entity. If multiple are supplied, this field is omitted. If no localities are matched, the API returns a 400 error.

filter.exclude.location.radius

integer

Radius (in meters) to apply when excluding a location defined by
filter.exclude.location.id or filter.exclude.location.query. A value of
0 restricts exclusion strictly to the boundary; a positive value expands the
exclusion zone.

filter.subtype

string

enum

Subtype to filter on.

Allowed:

model

string

enum

Model to base results on.

Allowed:

page

int32

1 to 100

Defaults to 1

The page number

take

integer

1 to 50

Defaults to 20

The number of results to return. Default is 20. The maximum allowed is 50.
To retrieve additional results, use the page parameter to access the next page of results. This is the recommended approach for pagination.
For specific cases, the offset parameter can be used with take to skip a set number of results.

offset

integer

The number of results to skip, starting from 0. Allows arbitrary offsets but is less commonly used than page.

Responses

200OK

404No results

429Rate limit exceeded