> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Preview Dash > Get a dashboard from its id NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-DashAgent.json post /api/v1/Agents/Dash/GetPreviewDash openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - DashAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Dash/GetPreviewDash: post: tags: - Dash_Agent summary: Get Preview Dash description: |- Get a dashboard from its id NsApiSlow threshold: 5000 ms. operationId: v1DashAgent_GetPreviewDash parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest description: DashboardId required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreviewDash' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreviewDash' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreviewDash' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreviewDash' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreviewDash' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreviewDash' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.DashCarriers.GetPreviewDashRequest: description: 'GetPreviewDash: Get a dashboard from its id' type: object properties: DashboardId: format: int32 type: integer SuperOffice.CRM.Services.PreviewDash: description: "Dashboard preview\r\n\r\nCarrier object for PreviewDash.\r\nServices for the PreviewDash Carrier is available from the Dash Agent." type: object properties: DashboardId: format: int32 description: Primary key type: integer Name: description: The name of this dashboard type: string Description: description: Detailed description type: string OwnedByFullName: description: Full name of dashboard owner type: string Registered: format: date-time description: Registered when in UTC. type: string Tiles: description: Dashboard tiles type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.PreviewDashTile' TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.PreviewDashTile: description: "Dashboard tile preview\r\n\r\nCarrier object for PreviewDashTile.\r\nServices for the PreviewDashTile Carrier is available from the Dash Agent." type: object properties: Name: description: The name of the tile type: string TileType: description: Dashboard tile type enum: - None - Pie - List - BigNum - Bar - Line - Area - Column - CombinedBarLine - CombinedColumnLine - WebPanel - HTML - Gauge - Funnel type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [SuperOffice.WebApi.Data.Dash GetPreviewDashRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_GetPreviewDashRequest.md) - [NSDashAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashAgent.md) - [SuperOffice.WebApi.Agents.DashAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DashAgent.md) - [SuperOffice.WebApi.Agents.IDashAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDashAgent.md) - [NSPreviewDash](/en/automation/crmscript/reference/CRMScript.NetServer.NSPreviewDash.md) - [NSPreviewDashTile](/en/automation/crmscript/reference/CRMScript.NetServer.NSPreviewDashTile.md)