Saltar al contenido

List earned media item rows

Módulo Projects

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.

  • Requiere la capacidad projects.gate.read.
  • Alcances de OAuth: projects.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

earnedMediaItems.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter 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.

Respuesta 200: una página de EarnedMediaItem

earnedMediaItems.list: EarnedMediaItem
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the earned media item.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
project_idstring (uuid)SíIdentifier of the project.
titlestringSíHeadline or title of the coverage.Restricciones: length 1 to 300
outletstringSíPublication, station, channel or account that ran it.Restricciones: length 1 to 200
medium"Online" | "Print" | "Broadcast" | "Podcast" | "Social"SíWhere the coverage ran.
published_onstring (date)SíDay it ran, on the project's calendar; never after today there.
urlstring (uri) | nullSíLink to the coverage; one live row per link in a project.
reachinteger | nullSíAudience the outlet reports for the piece; null when unreported.Restricciones: range 0 to any
tone"Positive" | "Neutral" | "Negative" | nullSíSentiment of the coverage; null until rated.
source"Manual" | "Import" | "Integration"SíHow the figure reached XOS.
source_referencestring | nullSíWhat the figure came from, such as an invoice, a meter reading or a file name.Restricciones: length 1 to 300
notestring | nullSíNote.Restricciones: 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
}

Ejemplos de código

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