AggKnowledge API

Company Vendorgraphics

Endpointhttps://api.aggknowledgeai.com

Company vendorgraphics

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/company

Returns company vendorgraphic enrichment data (Tier 3)

Company vendorgraphics › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Company vendorgraphics › Headers

x-api-key

string · required

API key for authentication

Company vendorgraphics › Request Body

Company vendorgraphics request

companyId

integer · int64

The AggKnowledge company ID.

object

Optional metadata to associate with the request. Will be returned in the response.

Company vendorgraphics › Responses

Enriched company data

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

POST/v2/{environment}/vendorgraphics/company

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/vendorgraphics/company \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "companyId": 590654273,
  "metadata": {
    "key": "string"
  }
}
'

shell

Example Request Body

{
  "companyId": 590654273,
  "metadata": {
    "key": "string"
  }
}

json

Example Responses

{
  "data": {
    "aggkCompanyId": 0,
    "productsOffered": [
      {
        "categories": [
          {
            "categoryHierarchy": [
              {
                "categoryId": 137,
                "level": 4,
                "name": "Procurement"
              }
            ],
            "id": 1785,
            "name": "Accounts Payable (AP) and Spend Analysis"
          }
        ],
        "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
        "id": 60436221725246776,
        "name": "Coupa",
        "vendorAggkCompanyId": 42971468
      }
    ],
    "productsUsed": [
      {
        "categories": [
          {
            "categoryHierarchy": [
              {
                "categoryId": 137,
                "level": 4,
                "name": "Procurement"
              }
            ],
            "id": 1785,
            "name": "Accounts Payable (AP) and Spend Analysis"
          }
        ],
        "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
        "firstObservation": "2023-01-01",
        "id": 60436221725246776,
        "lastObservation": "2023-12-31",
        "name": "Coupa",
        "usageSignalsAllTime": {
          "dnsDetectionCount": 20,
          "jobOpeningCount": 10,
          "reviewCount": 30,
          "timePeriod": "last_6_months",
          "totalCount": 100,
          "webDetectionCount": 40
        },
        "usageSignalsByTimePeriod": [
          {
            "dnsDetectionCount": 20,
            "jobOpeningCount": 10,
            "reviewCount": 30,
            "timePeriod": "last_6_months",
            "totalCount": 100,
            "webDetectionCount": 40
          }
        ],
        "vendorAggkCompanyId": 42971468
      }
    ],
    "servicesOffered": [
      {
        "id": 0,
        "name": "name"
      }
    ]
  },
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  }
}

json

application/json

Company relationships

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/company/relationships

Returns company relationships data (Tier 3)

Company relationships › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Company relationships › Headers

x-api-key

string · required

API key for authentication

Company relationships › Request Body

Company relationships request

companyId

integer · int64 · required

Company ID to fetch relationships for

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results. Important: When using pagination with filters (like lastSeenAfter), you must include the same filter parameters in subsequent requests along with the cursor.

lastSeenAfter

string

Filter relationships by last_seen_at date. Returns only relationships where last_seen_at is on or after this date. Accepts YYYY, YYYY-MM, or YYYY-MM-DD format. Note: This filter must be included in all paginated requests (along with the cursor) to maintain consistent results.

object

Optional metadata to associate with the request. Will be returned in the response.

Company relationships › Responses

Company relationships data

Response containing company relationships

object[] · required

List of company relationships

object

Minimal company metadata

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

hasProblems

boolean

Whether there are problems in the response

isRetryable

boolean

Whether the operation is retryable

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata associated with the request

POST/v2/{environment}/vendorgraphics/company/relationships

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/vendorgraphics/company/relationships \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "companyId": 12345,
  "cursor": "cursor",
  "lastSeenAfter": "2024-01-01",
  "metadata": {
    "key": "string"
  }
}
'

shell

Example Request Body

{
  "companyId": 12345,
  "cursor": "cursor",
  "lastSeenAfter": "2024-01-01",
  "metadata": {
    "key": "string"
  }
}

json

Example Responses

{
  "company": {
    "aggkCompanyId": 0,
    "linkedinUrl": "linkedinUrl",
    "name": "name",
    "website": "website"
  },
  "cursor": "cursor",
  "hasProblems": false,
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  },
  "relationships": [
    {
      "aggkCompanyId": 0,
      "firstSeenAt": "firstSeenAt",
      "lastSeenAt": "lastSeenAt",
      "linkedinUrl": "linkedinUrl",
      "name": "name",
      "relationshipType": "customer_vendor"
    }
  ]
}

json

application/json

Category customer search

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/search/customers/by-category

Return customers of products in a specified category (Tier 3)

Category customer search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Category customer search › Headers

x-api-key

string · required

API key for authentication

Category customer search › Request Body

Customers of category search request

categoryId

integer · int64 · required

The AggKnowledge category ID to search for customers.

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

object

Optional metadata to associate with the request. Will be returned in the response.

Category customer search › Responses

Enriched category customer data

cursor

string

Cursor for the next page of results. Null if there are no more results.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

POST/v2/{environment}/vendorgraphics/search/customers/by-category

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/vendorgraphics/search/customers/by-category \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "categoryId": 123456,
  "cursor": "cursor",
  "metadata": {
    "key": "string"
  }
}
'

shell

Example Request Body

{
  "categoryId": 123456,
  "cursor": "cursor",
  "metadata": {
    "key": "string"
  }
}

json

Example Responses

{
  "cursor": "cursor",
  "data": {
    "customers": [
      {
        "company": {
          "aggkCompanyId": 0,
          "displayName": "displayName",
          "name": "name",
          "pdlCompanyId": "pdlCompanyId"
        },
        "usage": [
          {
            "firstObservation": "2024-08-25",
            "lastObservation": "2024-08-25",
            "usageSignalsAllTime": {
              "dnsDetectionCount": 20,
              "jobOpeningCount": 10,
              "reviewCount": 30,
              "timePeriod": "last_6_months",
              "totalCount": 100,
              "webDetectionCount": 40
            },
            "usageSignalsByTimePeriod": [
              {
                "dnsDetectionCount": 20,
                "jobOpeningCount": 10,
                "reviewCount": 30,
                "timePeriod": "last_6_months",
                "totalCount": 100,
                "webDetectionCount": 40
              }
            ]
          }
        ]
      }
    ],
    "products": [
      {
        "categories": [
          {
            "categoryHierarchy": [
              {
                "categoryId": 137,
                "level": 4,
                "name": "Procurement"
              }
            ],
            "id": 1785,
            "name": "Accounts Payable (AP) and Spend Analysis"
          }
        ],
        "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
        "id": 60436221725246776,
        "name": "Coupa",
        "vendorAggkCompanyId": 42971468
      }
    ]
  },
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  }
}

json

application/json

Product customer search

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/search/customers/by-product

Return customers of a specified product (Tier 3)

Product customer search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Product customer search › Headers

x-api-key

string · required

API key for authentication

Product customer search › Request Body

Customers of product search request

productId

integer · int64 · required

The AggKnowledge product ID to search for customers.

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

object

Optional metadata to associate with the request. Will be returned in the response.

Product customer search › Responses

Enriched product customer data

cursor

string

Cursor for the next page of results. Null if there are no more results.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

POST/v2/{environment}/vendorgraphics/search/customers/by-product

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/vendorgraphics/search/customers/by-product \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "cursor": "cursor",
  "metadata": {
    "key": "string"
  },
  "productId": 590654273
}
'

shell

Example Request Body

{
  "cursor": "cursor",
  "metadata": {
    "key": "string"
  },
  "productId": 590654273
}

json

Example Responses

{
  "cursor": "cursor",
  "data": {
    "customers": [
      {
        "company": {
          "aggkCompanyId": 0,
          "displayName": "displayName",
          "name": "name",
          "pdlCompanyId": "pdlCompanyId"
        },
        "usage": [
          {
            "firstObservation": "2024-08-25",
            "lastObservation": "2024-08-25",
            "usageSignalsAllTime": {
              "dnsDetectionCount": 20,
              "jobOpeningCount": 10,
              "reviewCount": 30,
              "timePeriod": "last_6_months",
              "totalCount": 100,
              "webDetectionCount": 40
            },
            "usageSignalsByTimePeriod": [
              {
                "dnsDetectionCount": 20,
                "jobOpeningCount": 10,
                "reviewCount": 30,
                "timePeriod": "last_6_months",
                "totalCount": 100,
                "webDetectionCount": 40
              }
            ]
          }
        ]
      }
    ],
    "products": [
      {
        "categories": [
          {
            "categoryHierarchy": [
              {
                "categoryId": 137,
                "level": 4,
                "name": "Procurement"
              }
            ],
            "id": 1785,
            "name": "Accounts Payable (AP) and Spend Analysis"
          }
        ],
        "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
        "id": 60436221725246776,
        "name": "Coupa",
        "vendorAggkCompanyId": 42971468
      }
    ]
  },
  "isRetryable": true,
  "isSuccess": true,
  "metadata": {
    "key": "string"
  }
}

json

application/json

Person Vendorgraphics Product Catalog

Company vendorgraphics

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/company

Returns company vendorgraphic enrichment data (Tier 3)

Company vendorgraphics › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Company vendorgraphics › Headers

x-api-key

string · required

API key for authentication

Company vendorgraphics › Request Body

Company vendorgraphics request

companyId

integer · int64

The AggKnowledge company ID.

object

Optional metadata to associate with the request. Will be returned in the response.

Company vendorgraphics › Responses

Enriched company data

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

Company relationships

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/company/relationships

Returns company relationships data (Tier 3)

Company relationships › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Company relationships › Headers

x-api-key

string · required

API key for authentication

Company relationships › Request Body

Company relationships request

companyId

integer · int64 · required

Company ID to fetch relationships for

cursor

string

lastSeenAfter

string

object

Optional metadata to associate with the request. Will be returned in the response.

Company relationships › Responses

Company relationships data

Response containing company relationships

object[] · required

List of company relationships

object

Minimal company metadata

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

hasProblems

boolean

Whether there are problems in the response

isRetryable

boolean

Whether the operation is retryable

isSuccess

boolean

Whether the operation was successful

object

Caller-supplied metadata associated with the request

Category customer search

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/search/customers/by-category

Return customers of products in a specified category (Tier 3)

Category customer search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Category customer search › Headers

x-api-key

string · required

API key for authentication

Category customer search › Request Body

Customers of category search request

categoryId

integer · int64 · required

The AggKnowledge category ID to search for customers.

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

object

Optional metadata to associate with the request. Will be returned in the response.

Category customer search › Responses

Enriched category customer data

cursor

string

Cursor for the next page of results. Null if there are no more results.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request

Product customer search

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/search/customers/by-product

Return customers of a specified product (Tier 3)

Product customer search › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Product customer search › Headers

x-api-key

string · required

API key for authentication

Product customer search › Request Body

Customers of product search request

productId

integer · int64 · required

The AggKnowledge product ID to search for customers.

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

object

Optional metadata to associate with the request. Will be returned in the response.

Product customer search › Responses

Enriched product customer data

cursor

string

Cursor for the next page of results. Null if there are no more results.

object

isRetryable

boolean

If the request failed, whether the request is retryable with the same input. Always true for successful requests.

isSuccess

boolean

Whether or not the request resulted in a successful enrichment.

object

Caller-supplied metadata associated with the request