{"type":"api","title":"List dashboard filters","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/0e4c66ca-115a-3769-be5b-c6944add743f","info":{"description":"Manage ThousandEyes Dashboards.","title":"Dashboards API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"description":"Dashboards and Widgets operations","name":"Dashboards"},{"description":"Dashboard Snapshots CRUD operations","name":"Dashboard Snapshots"},{"name":"Dashboards Filters"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"description":"Returns a list of dashboard filters and its context within your account group.\n","operationId":"getDashboardsFilters","parameters":[{"description":"Optional search pattern parameter to filter list of dashboard filters by either name or description values.","explode":true,"in":"query","name":"searchPattern","required":false,"schema":{"example":"cea-filter","type":"string"},"style":"form"},{"description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response.","in":"query","name":"aid","required":false,"schema":{"example":"1234","type":"string"}}],"responses":{"200":{"content":{"application/hal+json":{"schema":{"description":"All global dashboard filters saved.","properties":{"dashboardFilters":{"items":{"description":"Response containing dashboard filter settings and context details.","properties":{"context":{"description":"List of filters to be applied to a dashboard.","items":{"description":"List of different datasource filters.","properties":{"dataSourceId":{"description":"Types of data source.","example":"VIRTUAL_AGENT","type":"string"},"filters":{"description":"List of different filter properties.","items":{"description":"List of different filter properties for a single datasource.","properties":{"filterId":{"description":"Data source property to filter by.","example":"TEST_LABEL","type":"string"},"values":{"description":"Values to filter by based on the specified `filterId`.","example":["45862","59749"],"items":{"type":"string"},"type":"array","uniqueItems":true},"metricIds":{"description":"Dashboard metric associated with the filter property.","example":["WEB_PAGE_LOAD_COMPLETION_RATE","WEB_TTFB","WEB_AVAILABILITY"],"items":{"type":"string"},"type":"array","uniqueItems":true}},"required":["filterId","metricIds","values"],"type":"object","$$ref":"#/components/schemas/ApiDataSourceFilter"},"type":"array","uniqueItems":true}},"required":["dataSourceId","filters"],"type":"object","$$ref":"#/components/schemas/ApiDataSourceFilters"},"type":"array","uniqueItems":true},"aid":{"description":"Account group ID of the filter.","example":"11","type":"string"},"id":{"description":"Unique ID of the dashboard filter.","example":"65bc18e8f2073a4a469cd958","type":"string"},"name":{"description":"The name of the dashboard filter, this must be unique.","example":"cea-filter","type":"string"},"description":{"description":"An optional description of the filter.","example":"Global filter for CEA widgets","type":"string"},"createdBy":{"description":"Details of user who created or modified the filter.","properties":{"uid":{"description":"Unique ID of the user.","example":"1","type":"string"},"name":{"description":"Name of the user.","example":"Test User","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiDashboardFilterUserDetails"},"modifiedDate":{"description":"Timestamp when the filter was last modified.","example":"2024-02-01T22:19:19Z","format":"date-time","type":"string"},"createdDate":{"description":"Timestamp when the filter was created.","example":"2024-02-01T22:19:19Z","format":"date-time","type":"string"},"modifiedBy":{"description":"Details of user who created or modified the filter.","properties":{"uid":{"description":"Unique ID of the user.","example":"1","type":"string"},"name":{"description":"Name of the user.","example":"Test User","type":"string"}},"type":"object","$$ref":"#/components/schemas/ApiDashboardFilterUserDetails"},"_links":{"description":"A links object containing the self link.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/SelfLinks"}},"required":["aid","context","id","name"],"type":"object","$$ref":"#/components/schemas/ApiContextFilterResponse"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/ApiContextFiltersResponse"}}},"description":"OK"},"400":{"content":{"application/problem+json":{"example":{"type":"about:blank","title":"Request validation failed. There are invalid or missing fields","status":400,"detail":"Your request object contains invalid fields.","instance":"/v7","errors":[{"code":"AM-5432","field":"firstName","message":"firstName cannot have fancy characters"},{"code":"DASH-5622","field":"password","message":"Password cannot be blank"}]},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"},"errors":{"description":"(Optional) When multiple errors occur, the details for each error are listed.","items":{"properties":{"code":{"description":"(Optional) A unique error type/code that can be referenced in the documentation for further details.","type":"string"},"field":{"description":"Identifies the field that triggered this particular error.","type":"string"},"message":{"description":"A short, human-readable summary of the error.","type":"string"}},"type":"object","$$ref":"#/components/schemas/ValidationErrorItem"},"nullable":true,"type":"array"}},"type":"object","$$ref":"#/components/schemas/ValidationError"}}},"description":"Bad Request"},"401":{"content":{"application/problem+json":{"schema":{"properties":{"error":{"example":"invalid_token","type":"string"},"error_description":{"example":"Invalid access token","type":"string"}},"type":"object","$$ref":"#/components/schemas/UnauthorizedError"}}},"description":"Unauthorized"},"403":{"content":{"application/problem+json":{"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Insufficient permissions to query endpoint"},"404":{"content":{"application/problem+json":{"example":{"type":"about:blank","title":"URI Resource Not Found","status":404,"detail":"Details explaining if the 404 error is related to an invalid URI or a wrong ID","instance":"/v7"},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Not found"},"429":{"content":{"application/problem+json":{"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Exhausted rate limit for the organization"},"500":{"content":{"application/problem+json":{"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"},"schema":{"properties":{"type":{"description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type.","type":"string"},"status":{"description":"The HTTP status code generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem.","type":"string"}},"type":"object","$$ref":"#/components/schemas/Error"}}},"description":"Internal server error"}},"summary":"List dashboard filters","tags":["Dashboards Filters"],"__originalOperationId":"getDashboardsFilters","security":[{"BearerAuth":[]}],"method":"get","path":"/dashboards/filters"}}