Content

Dashboard / Dashboard

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/dashboard/dashboard

Method: GET

Authorisation: Minimum role: USER

Name	Type	Source
group_ids	Int32[]	Query
timeframe	ENUM dashboard_kpi_timeframe
include_wizard	Boolean

Request body example

Response status: 200 (OK)

Response type: DTO_dashboard

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

Name	Type	Description
header	DTO_dashboard_qa	Header
faq_items	DTO_dashboard_qa[]	Faq items
featured_blog_post	DTO_dashboard_blog	Featured blog post
system_messages	DTO_system_message[]	System messages
quantities	DTO_dashboard_quantities	Quantities
kpis_this_period	DTO_dashboard_kpis	Kpis this period
kpis_previous_period	DTO_dashboard_kpis	Kpis previous period
tickets_latest	DTO_dashboard_tickets	Tickets latest
tickets_waiting_first_reply	DTO_dashboard_tickets	Tickets waiting first reply
groups	DTO_reference[]	Groups
wizard_light_items	DTO_wizard_light_item[]	Wizard light items
timeframe	ENUM dashboard_kpi_timeframe	Timeframe
primary_email	String	Primary email
any_tickets	Boolean	Any tickets

Name	Type	ReadOnly	Description
title	String		Title
description	String		Description

Name	Type	Description
title	String	Title
image_url	String	Image url
description	String	Description
url	String	Url

Name	Type	Description
icon	DTO_icon	Icon
title	String	Title
message_html	String	Message html
cta_text	String	Cta text
cta_url	String	Cta url
color_palette	String	Color palette
dismissable	Boolean	Dismissable

Name	Type	Description
id	Int32	Id
name	String	Name
file	String	File
tags	String[]	Tags
categories	String[]	Categories

Name	Type	Description
tickets_per_status	DTO_reference_color_count[]	Tickets per status
tickets_waiting_first_reply_count	Int32	Tickets waiting first reply count
reply_count_average	Double	Reply count average

Name	Type	ReadOnly	Description
value	Int32 (nullable)	ReadOnly	Value
bg_color	String	ReadOnly	Bg color
text_color	String	ReadOnly	Text color
id	Int32		Id
label	Object	ReadOnly	Label

Name	Type	Description
minutes_per_status	DTO_reference_color_count[]	Minutes per status
tickets_in_period	DTO_reference_count[]	Tickets in period
average_first_reply_minutes	Int32	Average first reply minutes
average_resolution_time_minutes	Int32	Average resolution time minutes

Name	Type	ReadOnly	Description
value	Int32 (nullable)	ReadOnly	Value
id	Int32		Id
label	Object	ReadOnly	Label

Name	Type	ReadOnly	Description
tickets	Object		Tickets
additional_count	Int32		Additional count

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

Name	Type	Description
title	String	Title
description	String	Description
description_long	String	Description long
button_text	String	Button text
url	String	Url
tooltip	String	Tooltip
category	String	Category
completed	Boolean	Completed

GET Dashboard / Temp dashboard

GET Dashboard / Wizard light