Pointerpro API allows users and 3rd-party applications to access Pointerpro resources programmatically. This API conforms to REST principles.
Professional Enterprise ReportR DistributR This guide will teach you:
- General API
- Authentication API
- Contacts API
- Surveys API
- Users API
- Dashboard API
- Reports API
- Deprecated API
- Email invitations
Our deprecated/public API is available to professional users, while our Enterprise API is available starting from our Enterprise plan.
To use APIs, it is necessary to possess the Client secret and Client ID. Please contact [email protected] and they will provide you with these credentials.
1. General API
The main API URL is https:// API.pointerpro .com/ v1
Two headers are required with each request:
- Add Authorization header with your API key as value. You can create and find your API key under My Account.
- Send the Content-Type header with value application/json
There is a maximum of 60 API requests per minute per API Key.
2. Authentication API
You can read the details about general access codes and how to implement them via API here:
https://documenter.getpostman.com/view/184445/UV5dfFca#dd8b25ba-d65b-40a0-a0b1-1c53fa4932a5
3. Contacts API
Create contacts via API call. Read more details in the Pointerpro contacts help guide:
https://documenter.getpostman.com/view/184445/UV5dfFca#f95d5b6a-cf93-448f-b338-8cc5b662a237
4. Surveys API
Copy an existing survey by URL. More info can be found here:
https://documenter.getpostman.com/view/184445/UV5dfFca#0e15a554-c963-40ac-b50c-fa003fe20d70
5. Users API
Create users via API call: You can find additional information here:
https://documenter.getpostman.com/view/184445/UV5dfFca#ac334a31-f0a7-4df9-b5ed-0747433065b8
6. Dashboard API
Get dashboard authorizations for given user. More info can be found here:
https://documenter.getpostman.com/view/184445/UV5dfFca#8aaa24a7-97a3-4302-8479-048404ebe4f0
7. Reports API
Send reports via API call. You can find additional information here:
https://documenter.getpostman.com/view/184445/UV5dfFca#ed0fb047-b5c1-4bad-80b9-fe2ceec7adbb
8. Deprecated API
The DEPRECATED API can be found here:
https://documenter.getpostman.com/view/2178574/S11KRK2H
9. Email invitations
Send email invitation via API call. You can find additional information here:
https://documenter.getpostman.com/view/184445/UV5dfFca#84ef5f8d-ee8a-49d6-b598-74fb22988c50
When you are sending email invitations via API, those are sent by default from the admin's account. However, Team members don't have access to the admin's contacts, and therefore the contact won’t be attached to the response.
In order for the Team members to be able to see the contacts in the responses, they have to be added in the same user group.
What's next?
- Google Tag Manager is a tag system that can be used for tracking and analytics on websites. It can be used to track respondents' behavior in your survey or to find out how effective an advert promoting your survey has been.
- Zapier is a tool that enables the transfer of data from one web app to another one. By using Zapier in combination with Pointerpro, you can send the data collected within your survey to create contacts in Pointerpro or send data to apps such as Mailchimp, Salesforce, Trello, and many more. For example, to transfer email addresses collected in a survey to a Mailchimp email list.
- Integromat allows you to automate many processes and simplifies the transfer of information between apps, saving you bags of time! Integromat offers similar features to Zapier but is more powerful as you can set a single event to trigger a number of different actions to be taken simultaneously.