Exporting Portal Usage

Edcel Ceniza Updated by Edcel Ceniza

Monitoring your clients' portal can be easily done from the admin console (see: Monitoring Portal Usage). You may also download the portal usage data using the DeskDirector API.

We have several API endpoints customer can use to gather portal usage stats. This can be accessed via https://[your-subdomain-here].deskdirector.com/swagger , then select API v2 from the top dropdown of the Swagger interface then click on “Explore”. Once you have the DeskDirector API V2 page open, look for Dashboards and expand it.

GET /api/v2/dashboards/portal/monthly/reports

Use “general” as Parameter value and it should show you the usage breakdown per month with the report entityID, number of users and activity Count.

GET /api/v2/dashboards/portal/monthly/reports/{reportId}

This endpoint is what you need to get a breakdown of user activity per month. Input a reportId from the first endpoint and this should show you the companies and contacts with their corresponding activity for that month.

POST /api/v2/dashboards/portal/monthly/reports/{reportId}/refresh

Sends a post request to refresh a specific monthly report (only works for updates to contact and company name).

GET /api/v2/dashboards/portal/pastweek/{type}

Use “general” as Parameter value and it should show you the usage breakdown the week before -- with the report entityID, number of users and activity Count.

How did we do?

Clean Tickets

TimeZest integration with DeskDirector

Contact