API: Reports
Please note this module is in BETA
NB: Requires Release 10.6.0.7 at a minimum
About
What are API Reports? API reports is a JSON data feed that you can set up using custom reports within Platinum. Each report will contain a unique key that will allow you to request and then receive data from your reports. The columns you've chosen within the report will be returned via the report feed. Please note the feed will be flat and not grouped.
Restrictions
5 active reports every 15 minutes. There will be a maximum of 10,000 records returned per report.
Getting Started
1. Sign into Platinum
2. Clicking on the "Everyone" menu option
3. Then choose "Report Center"
4. Click on "Other Reports"
5. If you don't have a custom report click "new custom report". Make sure you add columns before you save your report. If you already have already have one then choose the report you want.
6. Click the "Edit" button
7. Click the "Settings"
8. Toward the bottom, you should see the API Access Key.
Methods
Retrieve data feed
URL Parameters
Example Request
Example Response
"event": "",
"logid": "e7337627-f8e7-4167-8082-c0da8da053c2",
"data": {
"report": [
{
"vendor_ID": "",
"is_a_Vendor": "NO",
"activity_Date_Completed": "2016-02-12T00:00:00",
"activity_Assigned_To_Name": "Greg O'Geiger",
"activity_Outcome": "SUCCESSFUL"
},
{
"vendor_ID": "",
"is_a_Vendor": "NO",
"activity_Date_Completed": "2016-05-26T00:00:00",
"activity_Assigned_To_Name": "Greg O'Geiger",
"activity_Outcome": "SUCCESSFUL"
},
{
"vendor_ID": "",
"is_a_Vendor": "NO",
"activity_Date_Completed": "2016-08-17T00:00:00",
"activity_Assigned_To_Name": "",
"activity_Outcome": "SUCCESSFUL"
}
]
}
}