> ## 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 Dash Tile Definition > Gets a DashTileDefinition object. Calls the Dash agent service GetDashTileDefinition. NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/rest/openapi-v3-DashTileDefinition.json get /api/v1/DashTileDefinition/{id} openapi: 3.0.0 info: version: v1-REST title: SuperOffice REST API v1 description: SuperOffice REST API - DashTileDefinition 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/DashTileDefinition/{id}: get: tags: - DashTileDefinition summary: Get Dash Tile Definition description: "Gets a DashTileDefinition object.\n\nCalls the Dash agent service GetDashTileDefinition.\r\nNsApiSlow threshold: 5000 ms." operationId: v1DashTileDefinition_GetDashTileDefinition parameters: - name: id in: path description: The id of the DashTileDefinition to return. required: true schema: type: integer format: int32 - 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 responses: '200': description: DashTileDefinition found. content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.DashTileDefinitionWithLinks text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.DashTileDefinitionWithLinks application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.DashTileDefinitionWithLinks text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.DashTileDefinitionWithLinks application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.DashTileDefinitionWithLinks application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DashCarriers.DashTileDefinitionWithLinks '404': description: Not Found. security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.DashCarriers.DashTileDefinitionWithLinks: description: "Dashboard Tile definition\r\n\r\nDashTileDefinition entity with API _Links added." type: object properties: DashboardTileDefinitionId: format: int32 description: Primary key type: integer Name: description: The name of the tile type: string Description: description: Detailed description type: string DefaultHeight: format: int32 description: Default height when added to a dashboard type: integer DefaultWidth: format: int32 description: Default width when added to a dashboard type: integer TileType: description: Dashboard tile type enum: - None - Pie - List - BigNum - Bar - Line - Area - Column - CombinedBarLine - CombinedColumnLine - WebPanel - HTML - Gauge - Funnel type: string EntityType: description: Dashboard entity type enum: - None - Contact - Sale - Project - Appointment - Person type: string EntityName: description: The entity measured by this tile, defines what provider to use type: string SelectionId: format: int32 description: Selection holding the criterias for the tile definition type: integer CurrencyMode: description: Dashboard currency mode enum: - None - Base - Own - Specified type: string CurrencyCode: description: Currency code type: string Measure: description: Dashboard measure type (Count, Sum, Avg, etc.) enum: - None - CountAll - Sum - Average - Max - Min - Count type: string MeasureField: description: Field to be measured type: string SortBy: description: Sort by field type: string LayoutConfig: description: The JSON formatted layout config type: string SecondarySelectionId: format: int32 description: >- Selection holding the replaced or changed criterias (period comparisons etc) type: integer MeasureByField: description: Field to group by type: string Usage: description: Where this tile can be used enum: - None - Dashboard - Selection type: string ProviderName: description: Name of provider to use with this entity type - read only property 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' _Links: type: object additionalProperties: type: string 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 - [Get Dash Tile Definition](/en/api/reference/restful/agent/dash_agent/get-dash-tile-definition.md) - [NSDashTile](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashTile.md) - [SuperOffice.WebApi.Data.DashTileDefinition](/en/api/reference/webapi/SuperOffice.WebApi.Data.DashTileDefinition.md) - [NSDashAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashAgent.md) - [Get Dash Tile](/en/api/reference/restful/rest/dashtile/get-dash-tile.md)