If I wanted to create a report via SQL Server or Microsoft PowerBI, would the API be a good option for connecting the data to my external database? For my particular report, I don’t want to save the data, I just want to be able to read it when necessary.
I’m not extremely savvy in API, so any thoughts or input would be greatly appreciated!
Thanks in advance! :)
Generally speaking the available API resources are for basic data access and it is not well suited for running reports in a live fashion. Often when someone does want to report on PCR data through the API they will periodically poll the API for new and updated data and pull that into their own reporting database which you seemed to have mentioned here.
One hurdle would be how you plan on keep the data synchronized between the PCR database(s) and the external database(s).
The other major hurdle is availability of data points. Not every major data point in PCR is available through our public API.
I don’t have any knowledge of anyone wiring up the API with PowerBI but I do know of situations where developers have done some data synchronization and reported on it. As I do not know specifically what you are trying to report on I cannot offer much advice in the realm of if the report is feasible or not.
Thanks Wayne! That’s helpful.
I am also wondering if there is a way through the API that we can write to a custom field.
For instance, I was wondering if the API could read when a certain inbound activity’s last date was, and then write a number to a custom field.
Bob Smith’s name record has an EMAIL activity within the last 365 days – the API reads this and then flags it to write a 1 in the custom field. And then this might go on for 2 years, 3 years, etc.
Then, we could search on this custom field.
Also, once the data changes (because someone could have an activity in the past 2 years and then they come up with an email tomorrow), the API could read that again and that custom field could change again.
Thanks so much!
You are able to write custom fields to the database and search the activities. Are you attempting to identify active or inactive records through the API or records which haven’t had some sort of communication/interaction over a period of time?
In a nutshell, yes, that’s what I’m trying to do. But I want to be able to take that custom field and be able to use it in searches, if that makes sense.
I think I have some grasp of what you are trying to do. If you have any questions about using the API to access the data please let me know.
Great, thanks Wayne!
Are there any step by step documents out there for using the API? I’m not super familiar with API’s and setting them up, so I’m not positive where I should get started at to even try to develop this.
We have general documentation available at the following URL:
The Resource Definitions section is interactive so you can make some requests if you would like to get a quick view of something.
Great! Does PCR do any development with the API’s for clients as a project?
Currently we do not do custom API work for clients.