Fields

Name Type Description User-specified? Required? Default value Possible values Maximum length
id integer System-generated identifier. No Yes - - -
name string Name of helper. Yes Yes - - 255
selector string CSS selector of the HTML element to which the helper is attached. Yes Yes - - -
this_page_only boolean true if the helper is specific to a page, or false otherwise. Yes Yes false true, false -
url string The page URL on which this helper will be displayed. It is applicable only if this_page_only is true. It can either be a static URL (e.g. https://elev.io) or a wildcard URL (e.g. (.*).elev.(.*)/reporting(.*)). Yes No - - 255
action string The action triggered when the helper is displayed. It can be used to either open an article or module, or display a component/element. Yes Yes - article, module, component-search, component-article, component-category, component-suggestion 255
hide_after_view boolean true if the helper should not appear again after first view, or false otherwise. This applies only if action is article. Yes No false true, false -
display_type string The visual cue for the helper: a question mark, a pulsating dot, an underline or none. Yes No - qmark, throbber, underline, nothing 255
method string Where the helper is displayed: in sidebar (tab) or as popup (inline). Yes No - tab, inline 255
element_id integer Identifier of the associated article or module. Yes No - - -
element_title string Title of the associated article or category. No No - - -
created_at timestamp UTC timestamp of when the helper was first created. No Yes Request date - -
updated_at timestamp UTC timestamp of when the helper was last modified. No Yes Request date - -

Methods

List all helpers

  • GET: curl -X GET https://api.elev.io/v1/helpers
  • Sample JSON response body:
 {
"helpers": [
{
"id": 1,
"name": "Left nav docs",
"selector": "body div.app.off-canvas-wrap",
"url": "(.*).elev.(.*)/reporting(.*)",
"action": "module",
"display_type": "qmark",
"method": "tab",
"element_id": 3,
"element_title": "Self Help",
"this_page_only": false,
"hide_after_view": false,
"created_at": "2015-07-31T05:14:31.000000Z",
"updated_at": "2016-02-18T19:28:05.000000Z"
},
{
"id": 2,
"name": "Similar articles help",
"selector": "label:contains('Show similar articles when viewing article?')",
"url": "(.*).elev.(.*)/reporting(.*)",
"action": "article",
"display_type": "qmark",
"method": "tab",
"element_id": 6662,
"element_title": "How to show similar articles",
"this_page_only": false,
"hide_after_view": true,
"created_at": "2015-07-31T05:14:31.000000Z",
"updated_at": "2016-02-18T19:28:05.000000Z"
}
]
}

Get a helper

  • GET: curl -X GET https://api.elev.io/v1/helpers/<id>
  • Sample JSON response body:
 {
"helper": {
"id": 1,
"name": "Left nav docs",
"selector": "body div.app.off-canvas-wrap",
"url": "(.*).elev.(.*)/reporting(.*)",
"action": "module",
"display_type": "qmark",
"method": "tab",
"element_id": 3,
"element_title": "Self Help",
"this_page_only": false,
"hide_after_view": false,
"created_at": "2015-07-31T05:14:31.000000Z",
"updated_at": "2016-02-18T19:28:05.000000Z"
}
}

Create a helper

  • POST: curl -H "Content-Type: application/json" -X POST --data @body.json https://api.elev.io/v1/helpers
  • Sample JSON body:
 {
"helper": {
"name": "Left nav docs",
"selector": "body div.app.off-canvas-wrap",
"url": "(.*).elev.(.*)/reporting(.*)",
"action": "module",
"display_type": "qmark",
"method": "tab",
"element_id": 3,
"this_page_only": false,
"hide_after_view": false
}
}

Update a helper

  • PUT: curl -H "Content-Type: application/json" -X PUT --data @body.json https://api.elev.io/v1/helpers/<id>
  • Sample JSON body:
 {
"helper": {
"id": 42,
"name": "Left nav docs",
"selector": "body div.app.off-canvas-wrap",
"url": "(.*).elev.(.*)/reporting(.*)",
"action": "module",
"display_type": "qmark",
"method": "tab",
"element_id": 3,
"this_page_only": false,
"hide_after_view": false
}
}

Delete a helper

  • DELETE: curl -X DELETE https://api.elev.io/v1/helpers/<id>