List earned media item rows
Projects module
GET/earned-media-itemsearnedMediaItems.list
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 a cursor page of earned media item rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability projects.gate.read.
- OAuth scopes: projects.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse 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_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of EarnedMediaItem
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the earned media item. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| project_id | string (uuid) | Yes | Identifier of the project. |
| title | string | Yes | Headline or title of the coverage.Constraints: length 1 to 300 |
| outlet | string | Yes | Publication, station, channel or account that ran it.Constraints: length 1 to 200 |
| medium | "Online" | "Print" | "Broadcast" | "Podcast" | "Social" | Yes | Where the coverage ran. |
| published_on | string (date) | Yes | Day it ran, on the project's calendar; never after today there. |
| url | string (uri) | null | Yes | Link to the coverage; one live row per link in a project. |
| reach | integer | null | Yes | Audience the outlet reports for the piece; null when unreported.Constraints: range 0 to any |
| tone | "Positive" | "Neutral" | "Negative" | null | Yes | Sentiment of the coverage; null until rated. |
| source | "Manual" | "Import" | "Integration" | Yes | How the figure reached XOS. |
| source_reference | string | null | Yes | What the figure came from, such as an invoice, a meter reading or a file name.Constraints: length 1 to 300 |
| note | string | null | Yes | Note.Constraints: length 1 to 2000 |
{
"data": [
{
"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."
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/earned-media-items" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.earnedMediaItems.listAll()) {
console.log(row);
}for row in xos.earned_media_items.list_all():
print(row)xos earned-media-items list --all