Dashboard / Temp dashboard

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

Method: GET

Authorisation: Minimum role: USER

Request Arguments
Name Type Source

  Request body example

No input arguments
Response object

Response status: 200 (OK)

Response type: DTO_dashboard

Wrapper: DTO_response_wrap

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

  Response body example

DTO_dashboard
NameTypeReadOnlyDescription
headerDTO_dashboard_qaHeader
faq_itemsDTO_dashboard_qa[]Faq items
featured_blog_postDTO_dashboard_blogFeatured blog post
system_messagesDTO_system_message[]System messages
quantitiesDTO_dashboard_quantitiesQuantities
kpis_this_periodDTO_dashboard_kpisKpis this period
kpis_previous_periodDTO_dashboard_kpisKpis previous period
tickets_latestDTO_dashboard_ticketsTickets latest
tickets_waiting_first_replyDTO_dashboard_ticketsTickets waiting first reply
groupsDTO_reference[]Groups
wizard_light_itemsDTO_wizard_light_item[]Wizard light items
timeframeENUM dashboard_kpi_timeframeTimeframe
primary_emailStringPrimary email
any_ticketsBooleanAny tickets
DTO_dashboard_qa
NameTypeReadOnlyDescription
titleStringTitle
descriptionStringDescription
DTO_dashboard_blog
NameTypeReadOnlyDescription
titleStringTitle
image_urlStringImage url
descriptionStringDescription
urlStringUrl
DTO_system_message
NameTypeReadOnlyDescription
iconDTO_iconIcon
titleStringTitle
message_htmlStringMessage html
cta_textStringCta text
cta_urlStringCta url
color_paletteStringColor palette
dismissableBooleanDismissable
DTO_icon
NameTypeReadOnlyDescription
idInt32Id
nameStringName
fileStringFile
tagsString[]Tags
categoriesString[]Categories
DTO_dashboard_quantities
NameTypeReadOnlyDescription
tickets_per_statusDTO_reference_color_count[]Tickets per status
tickets_waiting_first_reply_countInt32Tickets waiting first reply count
reply_count_averageDoubleReply count average
DTO_reference_color_count
NameTypeReadOnlyDescription
valueInt32 (nullable)ReadOnlyValue
bg_colorStringReadOnlyBg color
text_colorStringReadOnlyText color
idInt32Id
labelObjectReadOnlyLabel
DTO_dashboard_kpis
NameTypeReadOnlyDescription
minutes_per_statusDTO_reference_color_count[]Minutes per status
tickets_in_periodDTO_reference_count[]Tickets in period
average_first_reply_minutesInt32Average first reply minutes
average_resolution_time_minutesInt32Average resolution time minutes
DTO_reference_count
NameTypeReadOnlyDescription
valueInt32 (nullable)ReadOnlyValue
idInt32Id
labelObjectReadOnlyLabel
DTO_dashboard_tickets
NameTypeReadOnlyDescription
ticketsObjectTickets
additional_countInt32Additional count
DTO_reference
NameTypeReadOnlyDescription
idInt32The id of the reference
labelObjectReadOnlyName/Label from referenced object.
DTO_wizard_light_item
NameTypeReadOnlyDescription
titleStringTitle
descriptionStringDescription
description_longStringDescription long
button_textStringButton text
urlStringUrl
tooltipStringTooltip
categoryStringCategory
completedBooleanCompleted
ENUM dashboard_kpi_timeframe
ValueNameDescription
0UNKNOWNUNKNOWN
1TODAYTODAY
2YESTERDAYYESTERDAY
3THIS_WEEKTHIS_WEEK
4LAST_4_WEEKSLAST_4_WEEKS
5LAST_12_WEEKSLAST_12_WEEKS
6ALL_TIMEALL_TIME