API: Reports – Workamajig

NOTE: This is an overview document to provide general information regarding the Workamajig API. For full documentation and sample code, please access the API guide provided from within the Workamajig UI via Menu > Admin/Manager > System Setup > Account Information > Connections > API > API Internal Documentation Link.

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.

Report Considerations

When creating a report in Workamajig there are 3 tabs that will affect the JSON data feed.

Layout - This section is used to define the fields that will available for the data feed. If the field is not added to the Columns, it will not be available to the data feed

Filters - This section allows you to setup fixed filters or prompt filters to restrict the volume and content of the data. It is highly recommended that you set these up to prevent hitting the API Report Restrictions.

Fixed Filter: this is a filter that has a defined result, such as Client ID Equal To 'ABC'. Each time the data is requested only data for this client is available.

Prompt Filter: this is a filter where the field is defined but the "result" would be defined prior to running the report. The "Get" call will need to define the filter "result". If the "Get" call does not contain the filter 'result" the filter is ignored.

Settings -This section contains the report API key

Methods

Retrieve data feed

GET /reports?reportKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090

URL Parameters

reportKey: required <the key of the report feed you're looking for>

Other parameters will be optional and will vary based on the report. If your custom report has filters you will be able to use these filters in the query string. For example, if "Activity Date Completed" is one of my filters within the custom report I can add it to the report request by replacing all the spaces with underscores and adding it the query string. Make sure to use the field name of the filter in the query string. The above example query will now look like this:

/reports?reportKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090&activity_date_completed=2016-05-29

The between filter will have two parameters and will require the use of the pipe character. For example: if my filter for "Activity Date Completed" is set up to use the between option then the query would look like this"

/reports?reportKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090&activity_date_completed=2016-05-29|2016-06-29

Please note all dates will be in ISO standard YYYY-MM-DDThh:mm:ss

Example Request

https://workamajig.com/api/beta1/reports?reportKey=L1IwaFgvZlYvenA4YmRVN1Q1RHVFQT090&activity_date=2016-05-29

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"
}
]
}
}