Guide to Web Accessible (REST API) data sources

Overview


In Klipfolio, a web accessible resource is used to access data from a web service, such as Twitter or LinkedIn, through a defined Application Programming Interface (API). The internet is home to thousands of web service APIs and Klipfolio's web accessible resource can be used to connect to most APIs that use the REST (REpresentational State Transfer) protocol and one of the following authentication methods (if authentication is required): As well, Klipfolio supports many web service APIs that use OAuth authentication.

NOTE: REST APIs with additional authentication requirements, such as an initial login request, may not be accessible using Klipfolio's web accessible resource.

How to read an API query


Each web service API has its own unique definition and requirements, and it is necessary to refer to the web service API documentation for specific details:
  • user credentials (for example, username and password)
  • authentication method (OAuth, basic HTTP, 2-step Auth or API Key)
  • web service URL (address of the web service being queried, for example, http://api.linkedin.com)
  • endpoint names (the resources available to be queried, for example, in http://api.linkedin.com/v1/people, people is the endpoint)
  • parameters
    • dimensions, such as time or geographic location
    • metrics, the data being requested
    • time span, usually specified by start and end dates
  • parameter formats, in particular date formats (for example, yyyy-MM-dd, epoch)
  • parameter combinations (which metrics can be used with which dimensions)
  • access method (GET, POST)
  • output format (CSV, JSON, XML)

API query syntax


Although there is no defined REST standard, many REST-based API queries use a syntax similar to:

<webServiceURL>/<version>/<endpointName>.<outputFormat>?<parameter1Name>=<parameter1Value>&<parameter2Name>=<parameter2Value>&<startDate>=01-01-2015&<endDate>={date.today}

A REST-based query may not include all elements shown. If the query includes parameters, the first parameter is prefixed with a question mark (?) and subsequent parameters are prefixed with and ampersand (&).

Signed Authentication Parameters


Some third-party APIs, such as Amazon Web Services and Moz, require a signed authentication parameter to be included in their API query to secure the identity of the user making the API query. A signed authentication parameter is comprised of one or more data elements, such as an API key or a user ID, that have been encrypted to produce a unique key. Klipfolio's Signed Authentication Builder (Hash Helper) provides a set of methods to create this signed authentication parameter. The data elements required to build the signed authentication parameter are specified by the third-party API. This signed authentication parameter is included in the API query following the same syntax as a regular parameter.

Examples

Yahoo Weather API query


http://weather.yahooapis.com/forecastrss?w=3369&u=c

where
<webserviceURL> = http://weather.yahooapis.com
<endpoint> = forecastrss
<parameter1Name> = w
<parameter1Value> = 3369
<parameter2Name> = u
<parameter2Value> = c

Twitter API query


https://api.twitter.com/1.1/followers/list.json

where
<webserviceURL> = https://api.twitter.com
<version> = 1.1
<endpoint> = followers/list
<outputFormat> = json

Supported methods


Klipfolio supports the GET and POST methods for requesting data from an API. The API will specify which method to use and most use GET, although certain APIs, such as Infusionsoft, require POST.

How to create a web accessible resource


In Klipfolio, to create a web accessible resource:
  1. Go to the Library and select the Data Sources tab.
  2. Click Create a New Data Source and select Web Accessible Resource.
  3. On the screen presented, fill in the required information:
    • URL: type the API query according to the web service's API specification
    • Format: select the output format returned by the API (Excel, CSV, JSON or XML)
    • Method: select the method required by the API (GET or POST).

  4. Set Query Parameters as required by the API. Type a name and value for each parameter required and set one of the following types:
    • Query - This is equivalent to the parameters in an API query. You can either include them in the URL or in this section.
    • Header - If required by the API (for example, Smartsheets), add parameters to the query Header.
    • Cookie - If required by the API, Cookie parameters are used for session-related data.

  5. Select the Authentication Type:

  6. To use a dynamic date range that is calculated each time the query is executed, use relative date values for start and end dates. For example, 

  7. &start-date={date.last30days}&end-date={date.today}

    Be sure the date format in the query matches that required by the API. For more information, refer to date range values.

  8. Click Get Resource, then Continue once the data is verified.
  9. Save and name the data source.

Connecting to data sources

  1. Klipfolio Data Source Integrations
  2. Creating data sources
  3. Best practices for uploading your data
  4. Updating data sources
  5. About data source refresh
  6. Install the latest Google Analytics KlipStart Dashboard
  7. NEW: Install the latest Google AdWords KlipStart (for MCC accounts only)
  8. Guide to Web Accessible (REST API) data sources
  9. Authentication method: OAuth Token Authentication for Web Accessible Data Source
  10. Why does Klipfolio need specific permissions to connect my service accounts?
  11. Authentication method: 2 Step Authentication
  12. Authentication method: Basic HTTP Authentication
  13. Authentication method: API Key Authentication
  14. Managing OAuth tokens for connected accounts
  15. Use date range parameters to modify data retrieval period
  16. NEW: Signed Authentication Builder (Hash Helper) (advanced)
  17. Locate a data source ID
  18. SQL Databases
  19. Use files from your computer as a data source
  20. Use Email Attachments as a data source
  21. Use Excel spreadsheets as a data source
  22. NEW: Use Adobe Analytics as a data source
  23. NEW: Use Alexa as a data source
  24. Use Asana as a data source
  25. NEW: Use Atlassian JIRA as a data source
  26. NEW: Use AWeber as a Data Source
  27. NEW: Use Basecamp as a data source
  28. Use Bitly as a data source
  29. Use Box as a data source
  30. NEW: Use Buffer as a data source
  31. NEW: Use CallRail as a data source
  32. Use Campaign Monitor as a data source
  33. NEW: Use Chargify as a data source
  34. Use Cloud Monitor as a data source
  35. Use comScore Digital Analytix as a data source
  36. NEW: Use Desk.com as a data source
  37. Use Dropbox as a data source
  38. Use Eloqua as a data source
  39. Use Facebook as a data source
  40. NEW: Use Facebook Ads as a data source
  41. NEW: Use FluidSurveys as a data source
  42. Use Freshdesk as a data source
  43. NEW: Use Fusebill as a data source
  44. Use FTP or SFTP as a data source
  45. NEW: Use Glassdoor as a data source
  46. Use Google+ as a data source
  47. NEW: Use Google AdWords as a data source
  48. Use Google Analytics as a data source
  49. Use Google Analytics to create a Multi-Channel Funnel (MCF) API data source
  50. NEW: Use Google Calendar as a data source
  51. Use Google Drive Apps as a data source
  52. Use Google Webmaster Tools as a data source
  53. NEW: Use Harvest as a Data Source
  54. NEW: Use GoSquared as a data source
  55. Use Heartbeat as a Data Source
  56. NEW: Use HubSpot as a data source
  57. NEW: Use iFormBuilder as a data source
  58. PREVIOUS: Use iFormBuilder as a data source
  59. Use Infusionsoft as a data source
  60. NEW: Use Insightly as a data source
  61. NEW: Use Instagram as a data source
  62. NEW: Use Intercom as a data source
  63. Use Intervals as a data source
  64. NEW: Use Lighthouse as a Data Source
  65. Use LinkedIn as a data source
  66. Use Localytics as a data source
  67. Use MailChimp as a data source
  68. NEW: Use Mixpanel as a data source
  69. NEW: Use Marketo as a data source
  70. NEW: Use Moz as a data source
  71. NEW: Use New Relic as a data source
  72. Use Nicereply as a data source
  73. Use Optimizely as a data source
  74. NEW: Use Pardot as a data source
  75. Use Pingdom as a data source
  76. NEW: Use Pipedrive as a data source
  77. Use Podio as a data source
  78. NEW: Use QuickBooks as a data source
  79. Use QuickBooks with the Email Attachment Connector
  80. NEW: Use Quintly as a data source
  81. Use Radian6 as a data source
  82. NEW: Use RSS news feeds as a data source
  83. Use Salesforce as a data source
  84. Use Searchmetrics as a data source
  85. Use Sendible as a data source
  86. NEW: Use Shopify as a data source
  87. Use ShoreTelSky as a data source
  88. NEW: Use Slack as a data source
  89. Use Smartsheet as a data source
  90. NEW: Use Stripe as a data source
  91. Use SurveyGizmo as a data source
  92. NEW: Use Swrve as a data source
  93. Use Toggl as a data source
  94. NEW: Use Trello as a data source
  95. NEW: Use Taleo as a data source
  96. NEW: Use Talkwalker as a data source
  97. NEW: Use Todoist as a data source
  98. Use Topsy as a data source
  99. Use Twitter as a data source
  100. Use UserVoice as a data source
  101. NEW: Use VKontakte as a data source
  102. Use Webtrends as a data source
  103. NEW: Use Xero as a data source
  104. Use XMLA as a data source
  105. NEW: Use Yahoo Finance as a data source
  106. Use YouTube Analytics as a data source
  107. Use Zendesk as a data source
  108. Use Zoho CRM as a data source
  109. Automate data upload using the data source API
  110. Use Unbounce as a data source
  111. Data examples

Feedback and Knowledge Base