Export post stats (CSV)

GET

/analytics/export-posts-csv

curl 'https://api.xholic.ai/v1/analytics/export-posts-csv' \
  -H "Authorization: Bearer $XHOLIC_API_KEY"

const response = await fetch("https://api.xholic.ai/v1/analytics/export-posts-csv", {
  headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` },
});
const result = await response.json();
console.log(result.summary);

import axios from "axios";

const { data } = await axios.get("https://api.xholic.ai/v1/analytics/export-posts-csv", {
  params: {},
  headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` },
});
console.log(data.summary);

import os
import requests

response = requests.get(
    "https://api.xholic.ai/v1/analytics/export-posts-csv",
    headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"},
    params={},
)
print(response.json()["summary"])

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.xholic.ai/v1/analytics/export-posts-csv", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("XHOLIC_API_KEY"))
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)
  fmt.Println(string(body))
}

<?php
$ch = curl_init("https://api.xholic.ai/v1/analytics/export-posts-csv");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('XHOLIC_API_KEY')],
]);
$result = json_decode(curl_exec($ch), true);
echo $result['summary'];

require "net/http"
require "json"

uri = URI("https://api.xholic.ai/v1/analytics/export-posts-csv")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)["summary"]

Every post in a period with its numbers as CSV text (up to 5,000 rows). Filters match how_did_it_do.

Authorizations

bearerAuth

Parameters

Query Parameters

range

string

Allowed values: today 7d 14d 30d 60d 90d 180d all

timezone

IANA timezone such as America/New_York. Use the user’s timezone.

string

>= 1 characters <= 100 characters

IANA timezone such as America/New_York. Use the user’s timezone.

kind

string

Allowed values: ALL POST REPLY REPOST QUOTE

origin

Any of:

string
string

string

Allowed values: NEURON BRAIN REMIX SCHEDULER EXTENSION NATIVE_X UNKNOWN

format

Any of:

string
string

string

Allowed values: TEXT IMAGE VIDEO LINK THREAD ARTICLE

search

string

<= 160 characters

sort

string

Allowed values: publishedAt impressions engagements engagementRate likes replies reposts quotes bookmarks profileClicks urlClicks followerGain bookmarkRate replyRate shareRate firstDayImpressions baselineMultiple

direction

string

Allowed values: asc desc

from

First day, YYYY-MM-DD; overrides range.

string

/^\d{4}-\d{2}-\d{2}$/

First day, YYYY-MM-DD; overrides range.

Last day, YYYY-MM-DD.

string

/^\d{4}-\d{2}-\d{2}$/

Last day, YYYY-MM-DD.

account

X account to act on, as @handle. Leave it out to use the connection’s default account.

string

>= 1 characters <= 64 characters

X account to act on, as @handle. Leave it out to use the connection’s default account.

Responses

200

Success

application/json

object

required

boolean

summary

required

One or two readable sentences about the result.

string

data

required

The result. Its shape depends on the action.

ids

object

key

additional properties

any

next

Array<string>

creditsCharged

number

dryRun

boolean

Example

{
  "ok": true
}

default

Error

application/json

object

required

boolean

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED INVALID_CREDENTIAL SCOPE_MISSING ROLE_NOT_PERMITTED ACCOUNT_NOT_FOUND SUBSCRIPTION_REQUIRED FEATURE_NOT_INCLUDED APP_ONLY INVALID_INPUT NOT_FOUND CONFLICT CREDITS_CONFIRMATION_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS X_DATA_LIMIT_REACHED UPSTREAM_UNAVAILABLE INTERNAL_ERROR

message

required

string

scope

required

string

Allowed values: account platform

retryAfterSeconds

integer

details

Example

{
  "ok": false,
  "error": {
    "code": "UNAUTHENTICATED",
    "scope": "account"
  }
}