Response envelope

AttributeTypeDescription
itemsArray[SingleResponse]Multiple SingleResponse objects (one for each batched query sent in request)

SingleResponse

AttributeTypeDescription
successfulBooleanIndicator whether request execution was successful
itemsArray[ResponseItem]Collection of entities returned by query
metaResponseMetaResponse metadata, e.g. pagination information, type, item counts, aggregation results, etc.

ResponseItem

AttributeTypeDescription
dataObjectSingle entity (deal, lead or contact) returned by query. It contains only attributes explicitly requested in projection
metaResponseItemMetaObject metadata, currently only contains object type

ResponseMeta

AttributeTypeDescription
typeenumAlways equal to collection
countIntegerNumber of items returned in the response
total_countTotal number of items matched by the query
linksPaginationCursorsPagination cursors
suggestionsSuggestionsResponseSuggestions results for requested attributes
aggregationsAggregationsResponseAggregations results for requested attributes

ResponseItemMeta

AttributeTypeDescription
typeStringType of the record

PaginationCursors

AttributeTypeDescription
prev_pageStringCursor for the previous page (if exists)
selfStringCursor for the current page
next_pageStringCursor for the next page (if exists)

SuggestionsResponse

AttributeTypeDescription
<name_of_the_attribute>Array[AnyType]Suggestions for attribute with given name

AggregationsResponse

AttributeTypeDescription
<name_of_the_attribute>AggregationsResponseItemAggregation result for attribute with given name

AggregationsResponseItem

AttributeTypeDescription
minAnyTypeMinimum value of the attribute
maxAnyTypeMaximum value of the attribute
sumNumberSum of all the values of the attribute
avgNumberAverage value of the attribute
countNumberCount of non-null values of the attribute
termsArray[TermResult]Top N values, ordered by document count (N defaults to 10)

TermResult

AttributeTypeDescription
termAnyTypeA term
countNumberNumber of documents containing term