POST/v3/live/vendorgraphics/customers/by-category

Customers of category

Returns a paginated list of companies that use products in the specified category, with usage signal details.

Version
v3
Billing
Company Vendorgraphics · Customers of category

Request body

  • categoryIdstringRequired
    The AggKnowledge category ID to search for customers.
  • 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.
Headers
x-api-key Required · API key for authentication

Response

  • cursorstring
    Cursor to use in the next request to retrieve more results. Absent when no more results exist.
  • customersobject[]
    Companies that are customers of the searched product(s)
    • companyobject
      Lightweight company details
    • usageobject[]
      Product usage records for this customer, one entry per product used
  • 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.
  • productsobject[]
    Products referenced in this response
  • 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