curl --request GET \
  --url https://api.heralded.ai/v1/brands/{brand_id}/overview \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.heralded.ai/v1/brands/{brand_id}/overview"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.heralded.ai/v1/brands/{brand_id}/overview', 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.heralded.ai/v1/brands/{brand_id}/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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.heralded.ai/v1/brands/{brand_id}/overview"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.heralded.ai/v1/brands/{brand_id}/overview")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heralded.ai/v1/brands/{brand_id}/overview")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "actions": [
    {
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z",
      "detail": "<string>",
      "evidence": {
        "answers_link": {
          "href": "<string>"
        },
        "prompts": [
          {
            "answer_count": 123,
            "answers_link": {
              "href": "<string>"
            },
            "named_count": 123,
            "prompt_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "text": "<string>"
          }
        ]
      },
      "group": "new",
      "holder": "you",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "kind": "<string>",
      "member": "writer",
      "not_seen_since_run": 123,
      "note": {
        "how_well_know": "<string>",
        "short_form": "<string>",
        "what_i_need_from_you": "<string>",
        "what_ill_do": "<string>",
        "whats_happening": "<string>",
        "why_it_matters": "<string>"
      },
      "outcome": "verified_up",
      "paid_off_at": "2023-11-07T05:31:56Z",
      "placed_position": 123,
      "preview": "<string>",
      "stage": "observe",
      "started_at": "2023-11-07T05:31:56Z",
      "title": "<string>"
    }
  ],
  "answers_citing_you": {
    "count": 123,
    "of": 123,
    "pct": 123
  },
  "daily_scans_since_weekly": 123,
  "diagnosis": {
    "drafts": {
      "draftable": 123,
      "ready": 123
    },
    "rival_gaps": {
      "count": 123,
      "prompts": 123,
      "top": [
        "<string>"
      ]
    },
    "rival_sources": {
      "count": 123,
      "top": [
        "<string>"
      ],
      "unavailable_scans": 123
    }
  },
  "headline": {
    "text": "<string>"
  },
  "heralded_score": {
    "answers": 123,
    "change": {
      "baseline": {
        "first_answer_at": "2023-11-07T05:31:56Z",
        "last_answer_at": "2023-11-07T05:31:56Z",
        "reports": 123
      },
      "cells_unpaired": 123,
      "delta": 123,
      "direction": "up",
      "high": 123,
      "low": 123,
      "real": true
    },
    "denominator": 123,
    "high": 123,
    "low": 123,
    "numerator": 123,
    "state": "measured",
    "trend": [
      {
        "answers": 123,
        "at": "2023-11-07T05:31:56Z",
        "break_label": "<string>",
        "high": 123,
        "low": 123,
        "state": "measured",
        "value": 123
      }
    ],
    "value": 123
  },
  "heralded_score_band": "<string>",
  "latest_read": {
    "read_at": "2023-11-07T05:31:56Z",
    "run_number": 123
  },
  "mentioned": {
    "answers": 123,
    "change": {
      "baseline": {
        "first_answer_at": "2023-11-07T05:31:56Z",
        "last_answer_at": "2023-11-07T05:31:56Z",
        "reports": 123
      },
      "cells_unpaired": 123,
      "delta": 123,
      "direction": "up",
      "high": 123,
      "low": 123,
      "real": true
    },
    "denominator": 123,
    "high": 123,
    "low": 123,
    "numerator": 123,
    "state": "measured",
    "trend": [
      {
        "answers": 123,
        "at": "2023-11-07T05:31:56Z",
        "break_label": "<string>",
        "high": 123,
        "low": 123,
        "state": "measured",
        "value": 123
      }
    ],
    "value": 123
  },
  "meta": {
    "data_as_of": {
      "completed_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "query": {}
  },
  "next_daily_scan_at": "2023-11-07T05:31:56Z",
  "next_weekly_scan_at": "2023-11-07T05:31:56Z",
  "open_action_count": 123,
  "period": {
    "excluded_reports": 123,
    "first_answer_at": "2023-11-07T05:31:56Z",
    "last_answer_at": "2023-11-07T05:31:56Z",
    "preset": "1w",
    "reports": 123
  },
  "praised": {
    "answers": 123,
    "change": {
      "baseline": {
        "first_answer_at": "2023-11-07T05:31:56Z",
        "last_answer_at": "2023-11-07T05:31:56Z",
        "reports": 123
      },
      "cells_unpaired": 123,
      "delta": 123,
      "direction": "up",
      "high": 123,
      "low": 123,
      "real": true
    },
    "denominator": 123,
    "high": 123,
    "low": 123,
    "numerator": 123,
    "state": "measured",
    "trend": [
      {
        "answers": 123,
        "at": "2023-11-07T05:31:56Z",
        "break_label": "<string>",
        "high": 123,
        "low": 123,
        "state": "measured",
        "value": 123
      }
    ],
    "value": 123
  },
  "readiness": {
    "pages_blocked": 123,
    "pages_checked": 123,
    "pages_readable": 123,
    "pages_unmeasured": 123
  },
  "recommended": {
    "answers": 123,
    "change": {
      "baseline": {
        "first_answer_at": "2023-11-07T05:31:56Z",
        "last_answer_at": "2023-11-07T05:31:56Z",
        "reports": 123
      },
      "cells_unpaired": 123,
      "delta": 123,
      "direction": "up",
      "high": 123,
      "low": 123,
      "real": true
    },
    "denominator": 123,
    "high": 123,
    "low": 123,
    "numerator": 123,
    "state": "measured",
    "trend": [
      {
        "answers": 123,
        "at": "2023-11-07T05:31:56Z",
        "break_label": "<string>",
        "high": 123,
        "low": 123,
        "state": "measured",
        "value": 123
      }
    ],
    "value": 123
  },
  "rivals": [
    {
      "domain": "<string>",
      "heralded_score": {
        "answers": 123,
        "change": {
          "baseline": {
            "first_answer_at": "2023-11-07T05:31:56Z",
            "last_answer_at": "2023-11-07T05:31:56Z",
            "reports": 123
          },
          "cells_unpaired": 123,
          "delta": 123,
          "direction": "up",
          "high": 123,
          "low": 123,
          "real": true
        },
        "denominator": 123,
        "high": 123,
        "low": 123,
        "numerator": 123,
        "state": "measured",
        "trend": [
          {
            "answers": 123,
            "at": "2023-11-07T05:31:56Z",
            "break_label": "<string>",
            "high": 123,
            "low": 123,
            "state": "measured",
            "value": 123
          }
        ],
        "value": 123
      },
      "is_you": true,
      "mentioned": {
        "answers": 123,
        "change": {
          "baseline": {
            "first_answer_at": "2023-11-07T05:31:56Z",
            "last_answer_at": "2023-11-07T05:31:56Z",
            "reports": 123
          },
          "cells_unpaired": 123,
          "delta": 123,
          "direction": "up",
          "high": 123,
          "low": 123,
          "real": true
        },
        "denominator": 123,
        "high": 123,
        "low": 123,
        "numerator": 123,
        "state": "measured",
        "trend": [
          {
            "answers": 123,
            "at": "2023-11-07T05:31:56Z",
            "break_label": "<string>",
            "high": 123,
            "low": 123,
            "state": "measured",
            "value": 123
          }
        ],
        "value": 123
      },
      "name": "<string>",
      "rank": 123,
      "recommended": {
        "answers": 123,
        "change": {
          "baseline": {
            "first_answer_at": "2023-11-07T05:31:56Z",
            "last_answer_at": "2023-11-07T05:31:56Z",
            "reports": 123
          },
          "cells_unpaired": 123,
          "delta": 123,
          "direction": "up",
          "high": 123,
          "low": 123,
          "real": true
        },
        "denominator": 123,
        "high": 123,
        "low": 123,
        "numerator": 123,
        "state": "measured",
        "trend": [
          {
            "answers": 123,
            "at": "2023-11-07T05:31:56Z",
            "break_label": "<string>",
            "high": 123,
            "low": 123,
            "state": "measured",
            "value": 123
          }
        ],
        "value": 123
      },
      "share_of_voice_pct": 123
    }
  ],
  "score_bands": [
    {
      "high": 123,
      "label": "<string>",
      "low": 123
    }
  ],
  "score_context": {
    "answers": 123,
    "brand_name": "<string>",
    "engines": 123,
    "first_answer_at": "2023-11-07T05:31:56Z",
    "last_answer_at": "2023-11-07T05:31:56Z",
    "prompts": 123
  },
  "since_started": {
    "current": 123,
    "first": 123,
    "first_report_at": "2023-11-07T05:31:56Z",
    "sentence": "<string>",
    "series": [
      {
        "break_label": "<string>",
        "completed_at": "2023-11-07T05:31:56Z",
        "degraded": true,
        "run_number": 123,
        "value": 123
      }
    ],
    "third_report_due_at": "2023-11-07T05:31:56Z"
  },
  "source_citation_evidence": "complete",
  "source_unavailable_scans": 0,
  "sources": [
    {
      "citation_share_pct": 123,
      "citations": 123,
      "domain": "<string>",
      "group": "own",
      "ownership": "own",
      "read_pages_naming_you": 123
    }
  ],
  "sources_mentioning_you": {
    "count": 123,
    "of": 123,
    "pct": 123
  },
  "understood": {
    "answers": 123,
    "change": {
      "baseline": {
        "first_answer_at": "2023-11-07T05:31:56Z",
        "last_answer_at": "2023-11-07T05:31:56Z",
        "reports": 123
      },
      "cells_unpaired": 123,
      "delta": 123,
      "direction": "up",
      "high": 123,
      "low": 123,
      "real": true
    },
    "denominator": 123,
    "high": 123,
    "low": 123,
    "numerator": 123,
    "state": "measured",
    "trend": [
      {
        "answers": 123,
        "at": "2023-11-07T05:31:56Z",
        "break_label": "<string>",
        "high": 123,
        "low": 123,
        "state": "measured",
        "value": 123
      }
    ],
    "value": 123
  },
  "verified_actions": {
    "rows": [
      {
        "action_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "after": 123,
        "before": 123,
        "completed_at": "2023-11-07T05:31:56Z",
        "credited_pts": 123,
        "gain": "<string>",
        "happened": "<string>",
        "title": "<string>"
      }
    ],
    "total": 123
  }
}

{
  "code": "invalid_cursor",
  "detail": "The cursor is invalid or belongs to a different query.",
  "instance": "example-request-id",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

{
  "code": "invalid_token",
  "detail": "The Authorization header carries no API key Heralded knows: it is missing, mistyped, revoked or expired.",
  "instance": "example-request-id",
  "status": 401,
  "title": "Unauthorized",
  "type": "about:blank"
}

{
  "code": "not_found",
  "detail": "Nothing here that this API key can read.",
  "instance": "example-request-id",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

{
  "code": "workspace_archived",
  "detail": "The API key's organization is archived.",
  "instance": "example-request-id",
  "status": 409,
  "title": "Conflict",
  "type": "about:blank"
}

{
  "code": "invalid_request",
  "detail": "The request's parameters are invalid; `errors` names each one.",
  "errors": [
    {
      "loc": [
        "query",
        "limit"
      ],
      "msg": "Input should be less than or equal to 100",
      "type": "less_than_equal"
    }
  ],
  "instance": "example-request-id",
  "status": 422,
  "title": "Unprocessable Content",
  "type": "about:blank"
}

{
  "code": "rate_limited",
  "detail": "This caller is past its requests for the minute. Retry after the seconds in Retry-After.",
  "instance": "example-request-id",
  "rate_limit": {
    "limit": 120,
    "remaining": 0,
    "reset": 60,
    "window": 60
  },
  "status": 429,
  "title": "Too Many Requests",
  "type": "about:blank"
}