{"type":"api","title":"Get DNS trace test results","meta":{"id":"/apps/pubhub/media/000-v7-apis/ff6e14c265afac5403651f22656824120ef8f3d0/beddd583-a5f3-3bb9-82a3-77fa650e7a7a","info":{"version":"7.0.89","title":"Test Results API","description":"Get test result metrics for Network and Application Synthetics tests."},"security":[{"BearerAuth":[]}],"tags":[{"name":"Network Test Results"},{"name":"Web HTTP Server Test Results"},{"name":"Web Page Load Test Results"},{"name":"Web Transactions Test Results"},{"name":"API Test Results"},{"name":"Web FTP Server Test Results"},{"name":"DNS Trace Test Results"},{"name":"DNS Server Test Results"},{"name":"DNSSEC Test Results"},{"name":"Voice SIP Server Test Results"},{"name":"Voice RTP Server Test Results"},{"name":"Network BGP Test Results"}],"externalDocs":{"description":"Find out more about Test Results","url":"https://docs.thousandeyes.com/product-documentation/getting-started/getting-started-with-cloud-and-enterprise-agent-tests#interpreting-test-results"},"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication token"}}},"spec":{"tags":["DNS Trace Test Results"],"summary":"Get DNS trace test results","description":"Returns a DNS record from the requesting agent's point of view. This is similar to dig +trace.\n","operationId":"getTestDnsTraceResults","parameters":[{"name":"testId","description":"Test ID","required":true,"in":"path","schema":{"type":"string","example":"202701"},"$$ref":"#/components/parameters/TestIdPath"},{"name":"aid","in":"query","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.","required":false,"schema":{"type":"string","example":"1234"},"$$ref":"#/components/parameters/AccountGroupId"},{"name":"window","in":"query","description":"A dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: `s` for seconds (default if no type is specified), `m` for minutes, `h` for hours, `d` for days, and `w` for weeks.\nFor a precise date range, use `startDate` and `endDate`.","schema":{"type":"string","pattern":"^\\d+(?:[smhdw]{1})?$","example":"12h"},"$$ref":"#/components/parameters/Window"},{"name":"startDate","in":"query","description":"Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.","schema":{"type":"string","format":"date-time","example":"2022-07-17T22:00:54Z"},"$$ref":"#/components/parameters/StartDateParameter"},{"name":"endDate","in":"query","description":"Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`.","schema":{"type":"string","format":"date-time","example":"2022-07-18T22:00:54Z"},"$$ref":"#/components/parameters/EndDateParameter"},{"name":"cursor","in":"query","example":null,"description":"(Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.","schema":{"type":"string","example":null},"$$ref":"#/components/parameters/PaginationCursor"}],"responses":{"200":{"description":"OK","content":{"application/hal+json":{"schema":{"type":"object","properties":{"results":{"x-paginated-items":true,"type":"array","items":{"type":"object","properties":{"date":{"type":"string","description":"Data point date UTC (ISO date-time format).","format":"date-time","example":"2022-07-17T22:00:54Z","readOnly":true},"roundId":{"type":"integer","description":"Epoch time (seconds) indicating the start time of the round","example":1384309800,"readOnly":true},"_links":{"type":"object","description":"A links object containing the ThousandEyes App link","readOnly":true,"properties":{"appLink":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/TestResultAppLinks","example":{"appLink":{"href":"https://app.thousandeyes.com/view/tests?__a=105&testId=195&roundId=1692916680&agentId=125"}}},"startTime":{"type":"integer","description":"Epoch time (seconds) indicating the start time of the round","example":1384309800,"readOnly":true,"$$ref":"#/components/schemas/StartTime"},"endTime":{"type":"integer","description":"Epoch time (seconds) indicating the end time of the round","example":1384309800,"readOnly":true,"$$ref":"#/components/schemas/EndTime"},"agent":{"type":"object","properties":{"agentId":{"type":"string","description":"Unique agent ID","example":"281474976710706","readOnly":true},"agentName":{"type":"string","description":"Agent name","example":"thousandeyes-stg-va-254","readOnly":true},"countryId":{"type":"string","description":"2-digit ISO country code","example":"US","readOnly":true},"location":{"type":"string","description":"Location of the agent.","example":"San Francisco Bay Area","readOnly":true}},"$$ref":"#/components/schemas/TestResultAgent"},"output":{"type":"string","description":"Verbose output from the trace request","example":"com.\t172800\tIN\tNS\ta.gtld-servers.net.\ncom.\t172800\tIN\tNS\tf.gtld-servers.net.\ncom.\t172800\tIN\tNS\tc.gtld-servers.net.\ncom.\t172800\tIN\tNS\tb.gtld-servers.net.\ncom.\t172800\tIN\tNS\td.gtld-servers.net.\ncom.\t172800\tIN\tNS\te.gtld-servers.net.\ncom.\t172800\tIN\tNS\tg.gtld-servers.net.\ncom.\t172800\tIN\tNS\tm.gtld-servers.net.\ncom.\t172800\tIN\tNS\th.gtld-servers.net.\ncom.\t172800\tIN\tNS\tj.gtld-servers.net.\ncom.\t172800\tIN\tNS\ti.gtld-servers.net.\ncom.\t172800\tIN\tNS\tl.gtld-servers.net.\ncom.\t172800\tIN\tNS\tk.gtld-servers.net.\n;; Received 498 bytes from 199.7.91.13(d.root-servers.net.) in 119 ms\n\nthousandeyes.com.\t172800\tIN\tNS\ta1.verisigndns.com.\nthousandeyes.com.\t172800\tIN\tNS\ta2.verisigndns.com.\nthousandeyes.com.\t172800\tIN\tNS\ta3.verisigndns.com.\nthousandeyes.com.\t172800\tIN\tNS\tu1.verisigndns.com.\n;; Received 266 bytes from 192.5.6.30(a.gtld-servers.net.) in 178 ms\n\napp.thousandeyes.com.\t300\tIN\tCNAME\tweb.thousandeyes.com.\nweb.thousandeyes.com.\t300\tIN\tCNAME\tlb-app.thousandeyes.com.\nlb-app.thousandeyes.com.\t3600\tIN\tA\t208.185.7.120\n;; Received 173 bytes from 209.112.113.33(a1.verisigndns.com.) in 178 ms\n\n","readOnly":true},"errorDetails":{"type":"string","description":"Error details, if an error were encountered","example":"Connection error","readOnly":true,"$$ref":"#/components/schemas/TestResultErrorDetails"},"queries":{"type":"integer","description":"How many queries were required to get to the requested result","example":3,"readOnly":true},"failedQueries":{"type":"integer","description":"How many queries failed while getting to the requested result","example":0,"readOnly":true},"finalServerQueried":{"type":"string","description":"DNS server that provided the final result","example":"a1.verisigndns.com.","readOnly":true},"finalQueryTime":{"type":"integer","description":"How long the final query took to return a response","example":178,"readOnly":true},"mappings":{"type":"string","description":"Final mappings returned from the request","example":"208.185.7.120","readOnly":true}},"$$ref":"#/components/schemas/DnsTraceTestResult"}},"test":{"description":"Each test includes additional fields depending on its `type`. Refer `/tests/{type}` endpoint to know the set of fields returned by a given `type`.","additionalProperties":true,"type":"object","properties":{"interval":{"type":"integer","enum":[60,120,300,600,900,1800,3600],"description":"Interval between test runs in seconds.","default":60,"example":60,"$$ref":"#/components/schemas/TestInterval"},"alertsEnabled":{"type":"boolean","description":"Indicates if alerts are enabled.","example":true},"enabled":{"type":"boolean","description":"Test is enabled.","example":true,"default":true,"$$ref":"#/components/schemas/Enabled"},"createdBy":{"type":"string","description":"User that created the test.","example":"user@user.com","readOnly":true,"$$ref":"#/components/schemas/TestCreatedBy"},"createdDate":{"type":"string","format":"date-time","description":"UTC created date (ISO date-time format).","example":"2022-07-17T22:00:54Z","readOnly":true,"$$ref":"#/components/schemas/TestCreatedDate"},"description":{"type":"string","description":"A description of the test.","example":"ThousandEyes Test"},"liveShare":{"type":"boolean","description":"Indicates if the test is shared with the account group.","example":false,"readOnly":true},"modifiedBy":{"type":"string","description":"User that modified the test.","example":"user@user.com","readOnly":true},"modifiedDate":{"type":"string","format":"date-time","description":"UTC last modification date (ISO date-time format).","readOnly":true,"example":"2022-07-17T22:00:54Z"},"savedEvent":{"type":"boolean","description":"Indicates if the test is a saved event.\n\n**Note**: **Saved Events** are now called **Private Snapshots** in the user interface. This change does not affect API.\n","readOnly":true},"testId":{"type":"string","description":"Each test is assigned an unique ID; this is used to access test information and results from other endpoints.","readOnly":true,"example":"281474976710706"},"testName":{"type":"string","description":"The name of the test. Test name must be unique.","example":"ThousandEyes Test"},"type":{"type":"string","enum":["api","agent-to-agent","agent-to-server","bgp","http-server","page-load","web-transactions","ftp-server","dns-trace","dns-server","dnssec","sip-server","voice"],"description":"This is a read only value, as test type is implicit in the test creation url.","readOnly":true,"example":"agent-to-server","$$ref":"#/components/schemas/TestType"},"_links":{"type":"object","description":"A list of links that can be accessed to get more information","properties":{"self":{"type":"object","description":"Reference to the test.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/TestSelfLink","example":{"href":"https://api.thousandeyes.com/v7/tests/{type}/281474976710706"}},"testResults":{"type":"array","description":"Reference to the test results.","items":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"},"example":[{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/network"},{"href":"https://api.thousandeyes.com/v7/test-results/281474976710706/path-vis"}],"$$ref":"#/components/schemas/TestResults"}},"readOnly":true,"$$ref":"#/components/schemas/TestLinks"}},"$$ref":"#/components/schemas/SimpleTest"},"startDate":{"type":"string","format":"date-time","example":"2022-07-17T22:00:54Z","description":"(Optional) When passing `window` or `startDate` parameter, the client will also receive the `startDate` field indicating the UTC start date of the data's time range being retrieved (ISO date-time format).","readOnly":true,"$$ref":"#/components/schemas/StartDate"},"endDate":{"type":"string","format":"date-time","example":"2022-07-18T22:00:54Z","description":"(Optional) When passing `window` or `endDate` parameter, the client will also receive the `endDate` field indicating the UTC end date of the data's time range being retrieved (ISO date-time format).","readOnly":true,"$$ref":"#/components/schemas/EndDate"},"_links":{"type":"object","description":"A links object containing pagination related link(s).","properties":{"previous":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"},"next":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"},"self":{"type":"object","description":"A hyperlink from the containing resource to a URI.","required":["href"],"properties":{"href":{"type":"string","description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id"},"templated":{"type":"boolean","description":"Should be true when the link object's \"href\" property is a URI template."},"type":{"type":"string","description":"Used as a hint to indicate the media type expected when dereferencing the target resource."},"deprecation":{"type":"string","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."},"name":{"type":"string","description":"Its value may be used as a secondary key for selecting link objects that share the same relation type."},"profile":{"type":"string","description":"A URI that hints about the profile of the target resource."},"title":{"type":"string","description":"Intended for labelling the link with a human-readable identifier"},"hreflang":{"type":"string","description":"Indicates the language of the target resource"}},"$$ref":"#/components/schemas/Link"}},"$$ref":"#/components/schemas/PaginationLinks"}},"$$ref":"#/components/schemas/DnsTraceTestResults"}}}},"400":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."},"errors":{"nullable":true,"type":"array","description":"(Optional) When multiple errors occur, the details for each error are listed.","items":{"type":"object","properties":{"code":{"type":"string","description":"(Optional) A unique error type/code that can be referenced in the documentation for further details."},"field":{"type":"string","description":"Identifies the field that triggered this particular error."},"message":{"type":"string","description":"A short, human-readable summary of the error."}},"$$ref":"#/components/schemas/ValidationErrorItem"}}},"$$ref":"#/components/schemas/ValidationError"},"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"}]}}},"$$ref":"#/components/responses/400"},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"invalid_token"},"error_description":{"type":"string","example":"Invalid access token"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/401"},"403":{"description":"Insufficient permissions to query endpoint","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/403"},"404":{"description":"Not found","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"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"}}},"$$ref":"#/components/responses/404"},"429":{"description":"Exhausted rate limit for the organization","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/429"},"500":{"description":"Internal server error","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"},"example":{"type":"about:blank","title":"Internal server error","status":500,"detail":"Optional detail about the internal error message.","instance":"/v7"}}},"$$ref":"#/components/responses/500"},"502":{"description":"Bad Gateway","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\"."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","description":"The HTTP status code generated by the origin server for this occurrence of the problem."},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem."}},"$$ref":"#/components/schemas/Error"}}},"$$ref":"#/components/responses/502"},"default":{"description":"An error occurred","$$ref":"#/components/responses/GeneralError"}},"__originalOperationId":"getTestDnsTraceResults","security":[{"BearerAuth":[]}],"method":"get","path":"/test-results/{testId}/dns-trace"}}