Export a report summary

get/reports/{reportId}/summary

Export a report summary, returning empty string for the common case where there is no summary

Request Samples

1

Response Samples

1This report calculates kumquats per acre.

Path Parameters

NameTypeRequiredDescription
reportId
string
true

Identifier of an existing report resource. Report identifiers are generated by the Reports API when reports are created.

Header Parameters

NameTypeRequiredDescription
Accept-Language
string
false

The user's language, which is used in both rendering and caching. For technical details, see section 5.3.5 of RFC 7231. It affects the language of reports if they have been translated. This setting overrides any other user preference that has been set, such as the "offline process locale" preference in Visual Analytics. If this header is not set and there is no user preference, the language is the default language of the service.

Accept-Locale
string
false

A "format locale" that is distinct from the user's language (Accept-Language). Its syntax is similar to Accept-Language. It is honored in running of queries and formatting of values. This setting overrides any other user preference that has been set, such as the "regional locale for formats" preference in Visual Analytics. If this header is not set and there is no user preference, the format locale is the default locale of the service.

Responses

StatusMeaningDescription
200OK

The report summary is returned, it might be an empty string

HeadersSchema
400Bad Request

Bad request error.

HeadersSchema