Skip to content

Get an earned media item

Projects module

GET/earned-media-items/{id}earnedMediaItems.get

A piece of earned media coverage of a project (gate 8, G8.MEASUREMENT_REPORTED), sourced, dated and linked. The earned media figures of the measurement summary are computed from these rows. A reach the source does not report is null (Unmeasured); a tone is null until rated. Returns one earned media item with its `ETag`. A earned media item the caller may not see returns 404.

  • Requires the capability projects.gate.read.
  • OAuth scopes: projects.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

earnedMediaItems.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the earned media item.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: EarnedMediaItem

earnedMediaItems.get: EarnedMediaItem
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the earned media item.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
project_idstring (uuid)YesIdentifier of the project.
titlestringYesHeadline or title of the coverage.Constraints: length 1 to 300
outletstringYesPublication, station, channel or account that ran it.Constraints: length 1 to 200
medium"Online" | "Print" | "Broadcast" | "Podcast" | "Social"YesWhere the coverage ran.
published_onstring (date)YesDay it ran, on the project's calendar; never after today there.
urlstring (uri) | nullYesLink to the coverage; one live row per link in a project.
reachinteger | nullYesAudience the outlet reports for the piece; null when unreported.Constraints: range 0 to any
tone"Positive" | "Neutral" | "Negative" | nullYesSentiment of the coverage; null until rated.
source"Manual" | "Import" | "Integration"YesHow the figure reached XOS.
source_referencestring | nullYesWhat the figure came from, such as an invoice, a meter reading or a file name.Constraints: length 1 to 300
notestring | nullYesNote.Constraints: length 1 to 2000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Summer Series opens on the pier",
  "outlet": "WLRN",
  "medium": "Broadcast",
  "published_on": "2026-10-08",
  "url": "https://northwindlive.example/files/site-plan.pdf",
  "reach": 120000,
  "tone": "Positive",
  "source": "Import",
  "source_reference": "Hauler invoice 4471",
  "note": "Two roll-off containers."
}

Code samples

curl -X GET "$XOS_BASE_URL/earned-media-items/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.earnedMediaItems.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.earned_media_items.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos earned-media-items get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f