Get an activity report

POST

https://api.close.com/api/v1/report/activity/

POST

/api/v1/report/activity/

curl -X POST https://api.close.com/api/v1/report/activity/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "datetime_range": {
    "end": "2019-01-08T00:00:00Z",
    "start": "2019-01-01T00:00:00Z"
  },
  "metrics": [
    "calls.outbound.all.count",
    "emails.sent.all.count"
  ],
  "query": {
    "saved_search_id": "save_ZVc26G33JTNiDNEFdZhBQAONg9cJHleAAHqBJakf239",
    "type": "saved_search"
  },
  "type": "overview",
  "users": [
    "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
    "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
  ]
}'

{
  "aggregations": {
    "totals": {
      "calls.outbound.all.count": 0,
      "emails.sent.all.count": 0
    }
  },
  "data": [
    {
      "calls.outbound.all.count": 0,
      "datetime": "2019-01-01T00:00:00+00:00",
      "emails.sent.all.count": 0
    },
    {
      "calls.outbound.all.count": 0,
      "datetime": "2019-01-02T00:00:00+00:00",
      "emails.sent.all.count": 0
    },
    {
      "calls.outbound.all.count": 0,
      "datetime": "2019-01-03T00:00:00+00:00",
      "emails.sent.all.count": 0
    },
    {
      "calls.outbound.all.count": 0,
      "datetime": "2019-01-04T00:00:00+00:00",
      "emails.sent.all.count": 0
    },
    {
      "calls.outbound.all.count": 0,
      "datetime": "2019-01-05T00:00:00+00:00",
      "emails.sent.all.count": 0
    },
    {
      "calls.outbound.all.count": 0,
      "datetime": "2019-01-06T00:00:00+00:00",
      "emails.sent.all.count": 0
    },
    {
      "calls.outbound.all.count": 0,
      "datetime": "2019-01-07T00:00:00+00:00",
      "emails.sent.all.count": 0
    }
  ],
  "queries": {
    "leads": {
      "calls.outbound.all.count": [
        "call(direction: \"outbound\" and outgoing_call_date >= \"2019-01-01T00:00:00.000+0000\" and outgoing_call_date < \"2019-01-08T00:00:00.000+0000\" and user in (\"user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA\", \"user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk\")) and in:\"save_ZVc26G33JTNiDNEFdZhBQAONg9cJHleAAHqBJakf239\""
      ],
      "emails.sent.all.count": [
        "email(direction: \"outgoing\" and sent >= \"2019-01-01T00:00:00.000+0000\" and sent < \"2019-01-08T00:00:00.000+0000\" and status: \"sent\" and user in (\"user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA\", \"user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk\")) and in:\"save_ZVc26G33JTNiDNEFdZhBQAONg9cJHleAAHqBJakf239\""
      ]
    }
  }
}

The activity report returns the organization’s metrics per time period (overview report) or user (comparison report).

Every report accepts the following parameters:

datetime_range: a time range to fetch data for. Either this field or relative_range needs to be specified.
relative_range: a relative time range to fetch data for. The allowed values are: today, this-week, this-month, this-quarter, this-year, yesterday, last-week, last-month, last-quarter, last-year, and all-time. Either this field or datetime_range needs to be specified.
query: a query to apply to the report to filter out data. The value of the field is a dictionary with the key type and any type-specific keys. For now only the type saved_search is allowed which takes the extra key saved_search_id to specify the ID of a saved search. This parameter is optional.
users: a list of user IDs to limit the report results to. This parameter is optional.
type: the type of the report. The available values are overview and comparison. This parameter is mandatory.
metrics: a list of metrics (see List Activity Metrics) to fetch for the report. This parameter is mandatory.

The report can be requested either in a JSON format or in a CSV file. The format can be specified with the accept header.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects any.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error