GetEventListCount

Description

Returns the number of events that satisfy 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.
`eventDateFilter` (int)	Specifies the range in dates of events that need to be returned. The default value is 0 (Past).
`eventTypeFilter` (EventTypeFilter)	Specifies the type of events that need to be returned. The default value is 0 (All).
`startDate` (DateTime)	When `eventSelection` = 2 (DateRange), specifies the lower date bound. No default value - always has to be specified.
`endDate` (Types)	When `eventSelection` = 2 (DateRange), specifies the upper date bound. No default value - always has to be specified.
`year` (int)	Specifies the year for which events should be returned, When not used -1 must be passed. The default value is 0.
`buffer` (int)	When `eventSelection` is 1 (Future), specifies the number of hours before the end date the event should be returned. Default is 0 (till event end date, the event is considered a Future event).

Sample URL

https://www.domain.com/feed/Event.svc/GetEventListCount?apiKey=c34993dcba1942418d97656f3ed00979&languageId=1&year=2010&eventDateFilter=3&eventTypeFilter=0

Sample Request

JSON

var data = {
    apiKey: apiKey,
    languageId: 1,
    tagList: 'Q1|Q2',
    eventDateFilter: 3,
    eventTypeFilter: 0,
    year: 2011
};

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

Sample Response

JSON

{
    "GetEventListCountResult": 29
}