List Analytics Point Contacts

Authorization

AuthorizationBearer <token>

In: header

Request Body

point

One value on a chart: a metric, plus the bucket and breakdown keys of its row.

Keys are the row's own keys: a stable id, null for the row without a value, or __other__ for the folded tail. Leave out a breakdown to cover all of its values (a table's total row).

timezone?string

Default"UTC"

outcome?string

Rates only: everyone, only converted contacts, or the rest.

Default"all"

Value in"all" | "converted" | "not_converted"

search?string|null

limit?integer

Ignored by the ids and CSV exports.

Default50

Range1 <= value <= 200

offset?integer

Default0

Range0 <= value

query

A live query over outbound facts. Saved on reports as query_json.

dashboard_filters?|null

Response Body

application/json

curl -X POST "https://api.obert.io/api/analytics/query/contacts" \
  -H "Content-Type: application/json" \
  -d '{
    "point": {
      "metric": "actions"
    },
    "query": {
      "metrics": [
        "actions"
      ]
    }
  }'

curl -X POST "https://api.obert.io/api/analytics/query/contacts" \  -H "Content-Type: application/json" \  -d '{    "point": {      "metric": "actions"    },    "query": {      "metrics": [        "actions"      ]    }  }'

{
  "point": {
    "metric": {
      "id": "actions",
      "label": "string",
      "format": "number",
      "empty_hint": "string"
    },
    "query": {
      "metrics": [
        "actions"
      ],
      "dimensions": [
        "date"
      ],
      "chart_type": "line",
      "date_range": {
        "kind": "preset",
        "preset": "today"
      },
      "interval": "day",
      "filters": [
        {
          "dimension": "date",
          "operator": "in",
          "values": [
            "string"
          ]
        }
      ],
      "breakdown_limit": 10,
      "compare_previous": false
    },
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z",
    "timezone": "string",
    "interval": "day",
    "bucket": "2019-08-24",
    "breakdown": [
      {
        "dimension": "date",
        "dimension_label": "string",
        "key": "string",
        "label": "string"
      }
    ],
    "value": 0
  },
  "figure_label": "string",
  "figure_format": "number",
  "converted_label": "string",
  "unconverted_label": "string",
  "total": 0,
  "converted_total": 0,
  "contacts": [
    {
      "lead": {
        "id": "string",
        "name": "string",
        "headline": "string",
        "title": "string",
        "company": "string",
        "avatar_url": "string",
        "linkedin_url": "string",
        "email": "string"
      },
      "figure": 0,
      "converted": true,
      "last_at": "2019-08-24T14:15:22Z",
      "campaigns": [
        {
          "key": "string",
          "label": "string"
        }
      ],
      "campaign_count": 0
    }
  ],
  "has_more": true,
  "warnings": [
    "string"
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List Analytics Point Contacts

Authorization

Request Body

Response Body

200application/json

422application/json

application/json

application/json