GET /v1/kcbot

Fetch metadata for KC Bots from your PX Subscription. The API provides you with the summary of basic information of each KC Bot that makes it easy to work with specific data.

Examples:

URI Results
GET /v1/kcbot?pageSize=100 Get first 100 KcBots.
GET /v1/kcbot?pageSize=100&pageNumber=1 Get next 100 KcBots.
GET /v1/kcbot?productId=1234LPSWUBFW Get KcBots of product 1234LPSWUBFW.

Important: The default pageSize on list calls is 200. The pageSize can be changed by adding a pageSize parameter to the URL (i.e. /v1/kcbot?pageSize=100) with a max pageSize=500.

To fetch a particular page, use the pageNumber parameter (zero based)

Query parameters

  • pageNumber integer(int32)

    Page number

    Default value is 0.

  • pageSize integer(int32)

    Number of events per page range[1,500]

    Default value is 200.

  • productId string

    Property Group

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • kcList array[object]

      Array of KC View

      Hide kcList attributes Show kcList attributes object
      • createdBy object
        Hide createdBy attributes Show createdBy attributes object
        • id string
        • name string
      • createdDate integer(int64)
      • defaultLanguage string
      • description string
      • environments array[string]
      • id string
      • languages array[object]
        Hide languages attributes Show languages attributes object
        • languageCode string
        • translated boolean
      • modifiedBy object
        Hide modifiedBy attributes Show modifiedBy attributes object
        • id string
        • name string
      • modifiedDate integer(int64)
      • name string
      • priority integer(int32)
      • productId string
      • productName string
      • status string
    • pageNumber integer(int32)

      Page number

    • isLastPage boolean

      True if no more records available on next page

  • 400

    Bad request

  • 401

    Unauthorized or bad API Key

  • 429

    Rate limit exceeded

GET /v1/kcbot
curl \
 --request GET 'https://api.aptrinsic.com/v1/kcbot'
Response examples (200)
{
  "kcList": [
    {
      "createdBy": {
        "id": "string",
        "name": "string"
      },
      "createdDate": 42,
      "defaultLanguage": "string",
      "description": "string",
      "environments": [
        "string"
      ],
      "id": "string",
      "languages": [
        {
          "languageCode": "string",
          "translated": true
        }
      ],
      "modifiedBy": {
        "id": "string",
        "name": "string"
      },
      "modifiedDate": 42,
      "name": "string",
      "priority": 42,
      "productId": "string",
      "productName": "string",
      "status": "string"
    }
  ],
  "pageNumber": 42,
  "isLastPage": true
}