1. API
  2. v1
  3. CORE
  4. INSIGHTS

Help Center




Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve Search Statistics

GET /api/v1/insights/helpcenter/search.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope insights

Arguments

Name Type Mandatory Description
start_at string
Timestamp in format YYYY-MM-DDThh:mm:ssTZD
end_at string
Timestamp in format YYYY-MM-DDThh:mm:ssTZD

Response

{
  "status": 200,
  "data": {
    "start_at": "2016-04-16T00:00:00+00:00",
    "end_at": "2016-04-16T00:00:00+00:00",
    "popular_searches": [
      {
        "name": "Brewing",
        "average_result_count": 10,
        "attempt_count": 5,
        "last_attempted_at": "2016-04-16T00:00:00+00:00",
        "resource_type": "report_helpcenter_query"
      },
      {
        "name": "Coffee",
        "average_result_count": 8,
        "attempt_count": 2,
        "last_attempted_at": "2016-04-16T00:00:00+00:00",
        "resource_type": "report_helpcenter_query"
      }
    ],
    "failed_searches": [
      {
        "name": "tip",
        "average_result_count": 0,
        "attempt_count": 5,
        "last_attempted_at": "2016-04-16T00:00:00+00:00",
        "resource_type": "report_helpcenter_query"
      },
      {
        "name": "Siphon",
        "average_result_count": 0,
        "attempt_count": 2,
        "last_attempted_at": "2016-04-16T00:00:00+00:00",
        "resource_type": "report_helpcenter_query"
      }
    ],
    "resource_type": "report_helpcenter_search"
  }
}

Articles

Retrieve Article Statistics

GET /api/v1/insights/helpcenter/articles.json

Information

Allowed for Collaborators, Agents, Admins & Owners
Scope insights

Response

    {
      "status": 200,
      "data": [
        {
    "id": 1,

    "legacy_id": null,
    "uuid": "44afa976-5041-57d2-820e-55ab43c4c6b9",
    "titles": [






{
    "id": 1,

    "resource_type": "locale_field"

}
    ],
    "slugs": [
        {
            "locale": "en-us",
            "translation": "1-v60-pour-over-brewing",
            "resource_type": "slug"
        }
    ],
    "contents": [






{
    "id": 1,

    "resource_type": "locale_field"

}
    ],
    "keywords": null,
    "section": {
    "id": 1,

    "resource_type": "section"

}
,
    "creator": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "author": 




{
    "id": 1,

    "resource_type": "user_minimal"

}
,
    "attachments": [],
    "download_all": null,
    "status": "PUBLISHED",
    "upvote_count": 0,
    "downvote_count": 0,
    "views": 0,
    "rank": 0,
    "tags": [],
    "is_featured": true,
    "allow_comments": true,
    "total_comments": 0,
    "created_at": "2016-04-13T07:32:51+00:00",
    "published_at": "2016-04-13T07:32:51+00:00",
    "updated_at": "2016-04-13T07:32:51+00:00",
    "helpcenter_url": "https://brewfictus.kayako.com/article/1",

    "resource_type": "article"

    ,"resource_url": "https://brewfictus.kayako.com/api/v1/articles/1"

}

      ],
      "resource_type": "article",
      "offset": 0,
      "limit": 10,
      "total_count": 1
    }