chaperone.guides.get ()

Returns the list of guides. You can set filters as first parameter to call the method. Currently Chaperone only supports the URL filter. Other filters will be added in the future. 

chaperone.guides.get({
url:‘https://example.com’
})

chaperone.guides.get_by_id ()

Returns the properties of the guide specified (when you specify the guide ID).

chaperone.guides.get_by_id(guide_id)

Return value

{                
id: 12345, // The unique guide ID                
title: ‘Some awesome guide’, // The guide title                
link: ‘https://example.com/somewhere’, // The URL where the guide starts
description: ‘Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.’, // The guide description
created_at: ‘2015-04-12 11:04:44 UTC’,                
updated_at: ‘2015-04-12 11:04:44 UTC’,                
share_url: ‘http://app.getchaperone.com/share/xxxxx'”>                http://app.getchaperone.com/share/xxxxx’, // The unique URL to share the guide                theme: ‘default’, // The ID of the theme used to show the guide                
items: [{                
id: 12345, // The unique item ID                
title: ‘Item title’, // The item title                
content: ‘Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.’, // The item content
element: ‘#some-selector’, // The CSS selector for the item target element                
type: ‘item’, // The item type. Can be ‘item’, ‘tooltip’ or ‘modal‘
},…]                
}
Did this answer your question?