GetFinancialReportListCount

Description

Returns number of FinancialReports filtered by input parameters. When any of the parameters is missed, then the default value is used.

Input Parameters

Parameter	Description
`apiKey` (string)	To use the Q4 API, you need to have an application key. We use this to track API usage. Currently, the use of the API is allowed only with prior permission. Requests for API keys are reviewed by staff. Please get in touch with support to get the API Key.
`languageId` (int)	Specifies the language for which financial reports should be returned. The default value is 1 (English).
`tagList` (string)	If specified, the result will be filtered by tags. Tags are pipe-delimited - 'tag1\|tag2'. The default is an empty string.
`year` (int)	Specifies the year for which events should be returned. When not used, -1 must be passed. The default value is 0.
`reportTypes` (string)	Specifies pipe delimited list of report type filters that will be used to return data. When it is not provided, the result will not be filtered by report type. Example: "Supplemental Report\|Annual Report". Valid values for report type are: First Quarter Second Quarter Third Quarter Fourth Quarter Supplemental Report Annual Report

Sample URL

https://domain.com/feed/FinancialReport.svc/GetFinancialReportListCount?apiKey=c34993dcba1942418d97656f3ed00979&reportTypes=First Quarter|Second Quarter

Sample Request

JSON

var data = {
    apiKey: 'c34993dcba1942418d97656f3ed00979',
    reportTypes: "First Quarter|Second Quarter"
}

$.ajax({
    type: "GET",
    url: "http://www.domain.com/feed/FinancialReport.svc/GetFinancialReportListCount",
    data: data,
    dataType: "json",
    success: OnLoadFinancialReportListCountSuccess,
    error: OnLoadError
});

Sample Response

JSON

{
    "GetFinancialReportListCountResult": 2
}