Get analytics

GET

operate

analytics

Get analytics

curl --request GET \
  --url https://api.darwin.so/api/v3/operate/analytics \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.darwin.so/api/v3/operate/analytics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.darwin.so/api/v3/operate/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.darwin.so/api/v3/operate/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v3/operate/analytics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "analytics": {
    "agentId": "<string>",
    "operationId": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "generatedAt": "2023-11-07T05:31:56Z",
    "activities": [
      {
        "eventType": "<string>",
        "count": 0
      }
    ],
    "campaigns": [
      {
        "status": "<string>",
        "count": 0
      }
    ],
    "executionAttempts": [
      {
        "status": "<string>",
        "count": 0
      }
    ],
    "settledTransactions": [
      {
        "currency": "<string>",
        "count": 0,
        "providerSubtotal": "<string>",
        "applicationFees": "<string>",
        "networkFees": "<string>"
      }
    ],
    "coverage": {
      "execution": "<string>",
      "revenue": "<string>",
      "discoveryImpressions": null,
      "latency": null,
      "advertisingDelivery": null
    }
  }
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

Use analytics:read. Supply agentId, an optional operationId, and optional ISO from and to timestamps. The window is [from, to), defaults to the last 30 days, and may span at most 90 days. The response reports activity by event type, campaigns created in the window by current state, canonical deal-linked execution attempts by status, and settled transaction amounts grouped by currency. Retries count as separate execution attempts. Amounts are decimal currency-unit strings, not integer cents; budgets are not revenue. coverage states what is measured. Discovery impressions, latency, and ad delivery are currently null: these datasets are not aggregated here. Do not render an unavailable metric as zero or infer completed outcomes from accepted requests.

Authorizations

x-api-key

string

header

required

Query Parameters

agentId

string

required

Required string length: 1 - 200

operationId

string

Required string length: 1 - 200

from

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

Response

Current owner-scoped result. A mutation retry returns its saved response.

analytics

object

required

Show child attributes

Last modified on October 19, 2026

Get analytics

curl --request GET \
  --url https://api.darwin.so/api/v3/operate/analytics \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.darwin.so/api/v3/operate/analytics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.darwin.so/api/v3/operate/analytics",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.darwin.so/api/v3/operate/analytics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.darwin.so/api/v3/operate/analytics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "analytics": {
    "agentId": "<string>",
    "operationId": "<string>",
    "from": "2023-11-07T05:31:56Z",
    "to": "2023-11-07T05:31:56Z",
    "generatedAt": "2023-11-07T05:31:56Z",
    "activities": [
      {
        "eventType": "<string>",
        "count": 0
      }
    ],
    "campaigns": [
      {
        "status": "<string>",
        "count": 0
      }
    ],
    "executionAttempts": [
      {
        "status": "<string>",
        "count": 0
      }
    ],
    "settledTransactions": [
      {
        "currency": "<string>",
        "count": 0,
        "providerSubtotal": "<string>",
        "applicationFees": "<string>",
        "networkFees": "<string>"
      }
    ],
    "coverage": {
      "execution": "<string>",
      "revenue": "<string>",
      "discoveryImpressions": null,
      "latency": null,
      "advertisingDelivery": null
    }
  }
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

Navigator

Publish

Agents

Account

Authorizations

Query Parameters

Response