List Ticket Linking Analytics

Following KCS principles, Guru's card linking lets users affirmatively link a card to a ticket, indicating that the card was used to solve it. That gives agents an easy way to report what content solved tickets, and gives admins insight into successful articles and content gaps. This endpoint returns every ticket a card has been linked to, along with the user, date, and card.

📘
Plan availability
Ticket linking is available on Expert and Enterprise plans. For more about ticket linking in Zendesk and LiveAgent, see the Help Center.

List KCS reports

GET https://api.getguru.com/api/v1/kcs

Query parameters

Parameter	Description
`platform`	The ticketing platform to query. Supported values: `ZENDESK`, `LIVEAGENT`.
`conversationId`	The identifier of the ticket the KCS reports were made for.
`cardId`	The identifier of the card to query KCS reports for.
`email`	Returns KCS reports made by the user with this email address.
`startDate`	Returns KCS reports made after this date.
`endDate`	Returns KCS reports made before this date.

Request

The call below gets all KCS reports on the Zendesk platform made after August 12th, 2019:

curl -u $GURU_USER:$GURU_TOKEN "https://api.getguru.com/api/v1/kcs?platform=ZENDESK&startDate=2019-08-12"

Response

Status code 200 and an array of KCS report objects:

[
  {
    "date": "2019-08-16T17:19:38.383+0000",
    "platform": "ZENDESK",
    "conversationId": "1183",
    "card": {
      "preferredPhrase": "Public Card Test",
      "verificationState": "TRUSTED",
      "cardType": "CARD",
      "shareStatus": "TEAM",
      "collection": {
        "color": "#2962FF",
        "id": "dc6c5b46-3112-4c04-bbe7-0312fb298a8f",
        "collectionType": "INTERNAL",
        "roiEnabled": true,
        "name": "Guru QA"
      },
      "id": "450459c6-20f7-4676-b345-16d27b6ec1cf",
      "slug": "cMEMgbbi/Public-Card-Test",
      ...
    },
    "user": {
      "status": "ACTIVE",
      "firstName": "Mike",
      "lastName": "AwesomeUser",
      "email": "[email protected]",
      "profilePicUrl": "https://lh3.googleusercontent.com/photo.jpg"
    }
  }
]

The card object matches the shape returned by the card endpoints, truncated here for readability.