POST/v2/live/vendorgraphics/search/customers/by-product

Product customer search

Returns customers of a specified product, with usage signal details, using cursor-based pagination (up to 500 results per page)

Version: v2
Rate limit: Tier 3 · 10–200 rps by plan
Billing: Company Vendorgraphics · Product customer search

Request body

cursorstringOptional
Cursor for pagination. Use the cursor value from the previous response to get more results.
metadataobjectOptional
Optional metadata to associate with the request. Will be returned in the response.
productIdinteger (int64)Required
The AggKnowledge product ID to search for customers.

Headers: x-api-key Required · API key for authentication

Response

cursorstring
Cursor for the next page of results. Null if there are no more results.
dataobject
isRetryableboolean
When isSuccess is false, whether sending the same input again could succeed. Always true when isSuccess is true.
isSuccessboolean
true when the request was answered with a result. false means no result was returned: check isRetryable, which is true when a data source failed or timed out and false when the input matched nothing.
metadataobject
Caller-supplied metadata echoed back from the request.
hasProblemsboolean
Whether we hit a problem answering the request: the profile or company wasn't found, or a data source failed or timed out. Data may be missing or incomplete; problems, where the response has it, says which.

Status codes

Response

Example

{
  "cursor": "eyJwYWdlIjoyLCJvZmZzZXQiOjEwMH0",
  "data": {
    "customers": [
      {
        "company": {},
        "usage": []
      }
    ],
    "products": [
      {
        "categories": [],
        "description": "Cloud data platform for warehousing, analytics, and secure data sharing.",
        "id": 48211,
        "name": "Snowflake Data Cloud",
        "vendorAggkCompanyId": 61230
      }
    ]
  },
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {}
}