Zilfu
API ReferenceAnalytics

Get an account's analytics report

The full report for one connected account: its metric catalogue, totals, interaction score, rates, publish-date series, audience history and best times. Individual posts have their own endpoint. Defaults to the last 7 days in the space timezone.

GET
/spaces/{space}/accounts/{account}/analytics
AuthorizationBearer <token>

In: header

Path Parameters

space*integer

The space ID

account*integer

The account ID

Query Parameters

from?string
Formatdate-time
to?string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://zilfu.app/api/spaces/0/accounts/0/analytics"
{
  "data": {
    "contract": "string",
    "account": {
      "id": 0,
      "social": "string",
      "display_name": "string",
      "handler": "string",
      "avatar": "string",
      "disconnected_at": "string"
    },
    "range": {
      "from": "string",
      "to": "string",
      "timezone": "string",
      "days": 0,
      "previous_from": "string",
      "previous_to": "string"
    },
    "basis": {
      "series": "string",
      "values": "string",
      "note": "string",
      "comparison_immature": true
    },
    "collection": {
      "state": "string",
      "reason": "string",
      "remedy": "string",
      "last_collected_at": "string",
      "cadence_hours": 0,
      "polling_window_days": 0
    },
    "coverage": {
      "posts_in_range": 0,
      "posts_imported": 0,
      "days_in_range": 0,
      "days_with_posts": 0
    },
    "metrics": [
      {
        "key": "string",
        "label": "string",
        "definition": "string",
        "unit": "string",
        "accumulation": "string",
        "scope": "string",
        "role": "string",
        "window_days": 0,
        "headline": true,
        "chartable": true,
        "status": "string",
        "reason": "string",
        "remedy": "string"
      }
    ],
    "headline_metric": "string",
    "totals": [
      {
        "key": "string",
        "label": "string",
        "unit": "string",
        "value": 0,
        "previous": 0,
        "change_pct": 0,
        "change_unit": "string",
        "status": "string",
        "reason": "string",
        "remedy": "string"
      }
    ],
    "interactions": {
      "key": "string",
      "label": "string",
      "definition": "string",
      "native": true,
      "source": "string",
      "components": [
        "string"
      ],
      "value": 0,
      "previous": 0,
      "change_pct": 0,
      "change_unit": "string",
      "status": "string",
      "reason": "string",
      "remedy": "string"
    },
    "rates": [
      {
        "key": "string",
        "label": "string",
        "definition": "string",
        "numerator_key": "string",
        "denominator_key": "string",
        "denominator_label": "string",
        "denominator_unit": "string",
        "basis": "string",
        "value": 0,
        "per_post_mean": 0,
        "previous": 0,
        "change_pp": 0,
        "change_unit": "string",
        "status": "string",
        "reason": "string",
        "remedy": "string"
      }
    ],
    "series": {
      "basis": "string",
      "values": "string",
      "note": "string",
      "interval": "string",
      "timezone": "string",
      "metrics": [
        "string"
      ],
      "points": [
        {
          "date": "string",
          "posts": 0,
          "values": {
            "property1": 0,
            "property2": 0
          }
        }
      ]
    },
    "audience": {
      "supported": true,
      "metrics": [
        "string"
      ],
      "points": [
        {
          "date": "string",
          "values": {
            "property1": 0,
            "property2": 0
          }
        }
      ],
      "labels": {
        "property1": "string",
        "property2": "string"
      },
      "latest": {
        "date": "string",
        "values": {
          "property1": 0,
          "property2": 0
        }
      },
      "change": {
        "property1": 0,
        "property2": 0
      }
    },
    "best_times": {
      "cells": [
        {
          "weekday": 0,
          "hour": 0,
          "posts": 0,
          "average": 0
        }
      ],
      "best": {
        "weekday": 0,
        "hour": 0,
        "posts": 0,
        "average": 0
      },
      "timezone": "string",
      "lookback_days": 0,
      "min_posts": 0,
      "max_average": 0,
      "status": "string",
      "reason": "string"
    }
  }
}
{
  "message": "string"
}
{
  "message": "string"
}
{
  "message": "string"
}
{
  "message": "string",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}