Skip to content
Jellypod
Esc
↑↓navigate↵open⌘Jpreview

Get Insights across all content

GET/v1/insights
Authorization
AuthorizationBearer token · headerrequired

API key issued from /settings/api-keys in the Jellypod studio. Send as Authorization: Bearer <key>.

Query parameters
periodstring

Reporting period in UTC days: 7d, 30d (default), month (month to date), last-month, last-week (the last complete Monday to Sunday week), or custom with from and to. Every number is compared with the period of equal length just before it.

default: "30d"
Allowed:7d30dmonthlast-monthcustomlast-week
fromstring<date>

First day (YYYY-MM-DD, UTC) of a custom period.

tostring<date>

Last day (YYYY-MM-DD, UTC) of a custom period, at most 180 days after from. A day after today reads as today.

kindstring

Count only Episodes, Videos, or Shorts.

Allowed:episodevideoshort
Responses
200

Organization-wide Insights for the period

dataInsightsrequired

Organization-wide performance for one period, with the same totals as the Studio Insights page.

Show properties
as_ofstring | nullrequired

ISO-8601 time the saved analytics behind these numbers were captured. Null when nothing has been captured yet.

channelsobject[]required

Items posted, plays, engagement, and net followers gained per source: feed (podcast feeds), player (the Jellypod player), and each connected channel. A null value means the source does not report it.

Show properties
Array of object
engagementobject | nullrequired
Show properties
commentsobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
reactionsobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
followersobject | nullrequired
Show properties
currentnumberrequired
previousnumberrequired
namestringrequired
networkstring | nullrequired
playsobject | nullrequired
Show properties
currentnumberrequired
previousnumberrequired
postsobject | nullrequired
Show properties
currentnumberrequired
previousnumberrequired
sourcestringrequired
Allowed:feedplayerchannel
completebooleanrequired

Whether every measured podcast has a saved analytics capture. When false the numbers are a floor rather than a total; retry later for a complete read.

periodstringrequired
Allowed:7d30dmonthlast-monthcustomlast-week
previousobjectrequired

The equal-length period just before range, which every previous value covers.

Show properties
endstring<date>required
startstring<date>required
rangeobjectrequired

Inclusive UTC days the current values cover.

Show properties
endstring<date>required
startstring<date>required
studio_urlstring<uri>required

The Studio Insights page for the same period and filter.

summaryobjectrequired

Total plays, watch time in seconds (Jellypod player and YouTube), items published, Channels posted to, and reactions and comments with their rate per play, each as current and previous. engagement is null when no source captured it.

Show properties
channels_postedobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
engagementobject | nullrequired
Show properties
commentsobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
reactionsobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
rateobjectrequired
Show properties
currentnumber | nullrequired
previousnumber | nullrequired
playsobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
publishedobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
watch_time_secobjectrequired
Show properties
currentnumberrequired
previousnumberrequired
takeawaysobject[]required

Up to three suggested next steps for the whole library, each with a Studio action.

Show properties
Array of object
actionobjectrequired
Show properties
labelstringrequired
urlstring<uri>required
bodystringrequired
idstringrequired
titlestringrequired
top_contentobject[]required

The five items with the most plays in range.

Show properties
Array of object
commentsnumber | nullrequired
idstringrequired
kindstringrequired
Allowed:episodevideoshortvoiceover
playsnumberrequired
published_atstring | nullrequired
reactionsnumber | nullrequired
titlestringrequired
watch_time_secnumberrequired
400

Validation failed or malformed request.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties
Array of object
fieldstringrequired
messagestringrequired
reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers
recoveryobject
Show properties
actionstringrequired
Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result
idempotency_keystring
Allowed:reusenew
poll_after_secondsnumber
min 0
toolstring
Allowed:list_characterslist_contentget_contentsave_podcast
request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error
401

Missing or invalid API key.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties
Array of object
fieldstringrequired
messagestringrequired
reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers
recoveryobject
Show properties
actionstringrequired
Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result
idempotency_keystring
Allowed:reusenew
poll_after_secondsnumber
min 0
toolstring
Allowed:list_characterslist_contentget_contentsave_podcast
request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error
403

Authenticated, but this API key does not have access to this resource.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties
Array of object
fieldstringrequired
messagestringrequired
reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers
recoveryobject
Show properties
actionstringrequired
Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result
idempotency_keystring
Allowed:reusenew
poll_after_secondsnumber
min 0
toolstring
Allowed:list_characterslist_contentget_contentsave_podcast
request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error
404

Resource not found.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties
Array of object
fieldstringrequired
messagestringrequired
reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers
recoveryobject
Show properties
actionstringrequired
Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result
idempotency_keystring
Allowed:reusenew
poll_after_secondsnumber
min 0
toolstring
Allowed:list_characterslist_contentget_contentsave_podcast
request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error
429

Rate limit exceeded. Wait Retry-After seconds before retrying; RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset describe the window.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties
Array of object
fieldstringrequired
messagestringrequired
reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers
recoveryobject
Show properties
actionstringrequired
Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result
idempotency_keystring
Allowed:reusenew
poll_after_secondsnumber
min 0
toolstring
Allowed:list_characterslist_contentget_contentsave_podcast
request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error
500

Internal server error.

detailstring

Longer human-readable explanation when available.

errorsobject[]

Per-field validation failures. Present when type is validation_error.

Show properties
Array of object
fieldstringrequired
messagestringrequired
reasonstring

Script import failure when one or more Speakers have no saved Character match.

Allowed:unresolved_speakers
recoveryobject
Show properties
actionstringrequired
Allowed:correct_inputchoose_characterscheck_accountpoll_contentopen_studiocheck_contentreconnectretrycheck_result
idempotency_keystring
Allowed:reusenew
poll_after_secondsnumber
min 0
toolstring
Allowed:list_characterslist_contentget_contentsave_podcast
request_idstring

Correlation id, also returned in the X-Request-Id response header. Include in support requests.

speakersstring[]

Speaker labels needing a saved Character match when reason is unresolved_speakers.

statusintegerrequired

HTTP status code mirrored from the response.

titlestringrequired

Short human-readable summary.

typestringrequired

Machine-readable error class. Suitable for switch/match in client code.

Allowed:bad_requestvalidation_errorunauthorizedforbiddennot_foundconflictmethod_not_allowedunsupported_media_typeunprocessable_entityrate_limitedbad_gatewayinternal_error
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.jellypod.com/v1/insights' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "as_of": "string",
    "channels": [
      {
        "engagement": {
          "comments": {
            "current": 0,
            "previous": 0
          },
          "reactions": {
            "current": 0,
            "previous": 0
          }
        },
        "followers": {
          "current": 0,
          "previous": 0
        },
        "name": "string",
        "network": "string",
        "plays": {
          "current": 0,
          "previous": 0
        },
        "posts": {
          "current": 0,
          "previous": 0
        },
        "source": "feed"
      }
    ],
    "complete": true,
    "period": "7d",
    "previous": {
      "end": "2019-08-24",
      "start": "2019-08-24"
    },
    "range": {
      "end": "2019-08-24",
      "start": "2019-08-24"
    },
    "studio_url": "http://example.com",
    "summary": {
      "channels_posted": {
        "current": 0,
        "previous": 0
      },
      "engagement": {
        "comments": {
          "current": 0,
          "previous": 0
        },
        "reactions": {
          "current": 0,
          "previous": 0
        },
        "rate": {
          "current": 0,
          "previous": 0
        }
      },
      "plays": {
        "current": 0,
        "previous": 0
      },
      "published": {
        "current": 0,
        "previous": 0
      },
      "watch_time_sec": {
        "current": 0,
        "previous": 0
      }
    },
    "takeaways": [
      {
        "action": {
          "label": "string",
          "url": "http://example.com"
        },
        "body": "string",
        "id": "string",
        "title": "string"
      }
    ],
    "top_content": [
      {
        "comments": 0,
        "id": "string",
        "kind": "episode",
        "plays": 0,
        "published_at": "string",
        "reactions": 0,
        "title": "string",
        "watch_time_sec": 0
      }
    ]
  }
}

Was this page helpful?