POST/v3/live/company/products-used

Products used by company

Returns a paginated list of products used by the specified company

Version
v3
Billing
Company Vendorgraphics · Products used by company

Request body

  • companyIdstringRequired
    AggKnowledge company ID
  • cursorstringOptional
    Cursor for pagination from a previous response
  • 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.
  • 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.
  • productsUsedobject[]
    Products used by the company
    • categoryIdsstring[]
      Category IDs this product belongs to
    • firstObservationstring
      Date this product usage was first observed
    • lastObservationstring
      Date this product usage was most recently observed
    • productDescriptionstring
      Product description
    • productIdstring
      AggKnowledge product ID
    • productNamestring
      Product name
    • usageSignalsAllTimeobject
      All-time usage signal counts
    • usageSignalsByTimePeriodobject[]
      Usage signal counts broken down by time period
    • vendorAggkCompanyIdstring
      AggKnowledge company ID of the vendor offering this product
  • 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