GET /v1/stats/entity/by_date

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service

HTTP Method: GET

Path: /v1/stats/entity/by_date

Authentication: API Key required

Description: Get a count of how many times an entity has been served by the Central Index API in a given period of time

Parameters:

Sample Responses:

If month is provided, the API will produce a response that shows how many times the entity has been served in advertiser search API calls ("advertiser"), in regular search API calls ("serps") and in single entity API calls ("bdp" - Business Details Page),  how many emails have been sent to the business via the CI messaging path ("emails").

In addition, the following data points will be reported for actions that originate on sites that are powered by Central Index:

• gallery - views of entity photo gallery
• mappin  - clicks on entity map pin
• social  - clicks on any social links on the entity profile
• telephone - clicks to call on the entity  phone numbers
• video - clicks on entity video 
• website - clicks on link to entity website 

{
    "success": true,
    "msg": "ok",
    "data": [
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "advert",
            "value": 81
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "bdp",
            "value": 100
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "email",
            "value": 60
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "gallery",
            "value": 76
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "mappin",
            "value": 66
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "serps",
            "value": 71
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "social",
            "value": 62
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "telephone",
            "value": 70
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "video",
            "value": 86
        },
        {
            "entity_id": "437932693745664",
            "year": 2013,
            "month": 6,
            "event_type": "website",
            "value": 69
        }
    ]
}

If only year is provided, the API will produce a response that shows the above values rolled up into one number for each month of the given year.

{
    "success": true,
    "msg": "ok",
    "data": [
        {
            "entity_id": "379236639285248",
            "year": 2013,
            "month": 3,
            "value": 104
        },
        {
            "entity_id": "379236639285248",
            "year": 2013,
            "month": 4,
            "value": 794
        },
        {
            "entity_id": "379236639285248",
            "year": 2013,
            "month": 5,
            "value": 283
        }
    ]
}