Help Docs Developer Resources Report API Report Types
For details on how to run reports using the API, see Report API.
title
: (required, string) Conversations
action
: (list) Contacts contacted in the provided list of actions(projects) to include in the report, also support ranges in the format NUM1-NUM2.
noaction
: (list) Do not include contacts contacted in the provided list of actions/projects.
reaction
: (list) Include contacts who replied in the provided list of actions/projects.
gid
: (list) Include contacts belonging to the provided list of group IDs.
msgtime
(bigint): Pair of timestamps in milliseconds to filter by last message date/time, if only one timestamp is provided it will pull all records after that date.
flags
: (list) Filter by contact flags.
noflags
: (list) Filter by contact without flags.
in_mtime
: (bigint) Filter by contact inbound message timestamp in milliseconds.
out_mtime
: (bigint) Filter by contact outbound message timestamp in milliseconds.
q
: Query string to search all fields.
filter
: Filter by various cases, if not provided implies All
all
: All
Includes all messages.
unread
: Unread
Messages with unread or unresponded-to replies.
replied
: Contact Replied
Messages where the contact has replied.
responded
: Texter Responded
Messages where the texter has responded.
delivered
: Delivered
Messages that have provider delivery receipts.
error
: Undelivered
Messages with failed or missing provider delivery receipts.
modified
: Texter Modified
Texter-modified messages that require admin approval.
dailycap
: Dailycapped
Messages not delivered due to exceeding the daily cap.
unreachable
: Unreachable
Messages not delivered due to an error skip condition.
nocarrier
: Carrier Skip
Messages not delivered due to a carrier skip condition.
expired
: Expired
Mssages not delivered due to an invalid time range.
replies
: All Replies
Messages with contact replies, including those system-filtered as opt-outs.
curl -XPOST -u CID:KEY -d 'title=Conversations&msgtime=1753630726743' https://app.rumbleup.com/api/report/create
Response:
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Conversations",
"title": "Conversations",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "msgtime": 1753630726743 },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
title
: (required, string) Download Contacts
action
: (list) Contacts contacted in the provided list of actions(projects) to include in the report, also support ranges in the format NUM1-NUM2.
noaction
: (list) Do not include contacts contacted in the provided list of actions/projects.
reaction
: (list) Include contacts who replied in the provided list of actions/projects.
gid
: (list) Include contacts belonging to the provided list of group IDs.
msgtime
(bigint): Pair of timestamps in milliseconds to filter by last message date/time, if only one timestamp is provided it will pull all records after that date.
flags
: (list) Filter by contact flags.
noflags
: (list) Filter by contact without flags.
in_mtime
: (bigint) Filter by contact inbound message timestamp in milliseconds.
out_mtime
: (bigint) Filter by contact outbound message timestamp in milliseconds.
q
: Query string to search all fields.
filter
: Filter by various cases, if not provided implies All
all
: All
Includes all messages.
unread
: Unread
Messages with unread or unresponded-to replies.
replied
: Contact Replied
Messages where the contact has replied.
responded
: Texter Responded
Messages where the texter has responded.
delivered
: Delivered
Messages that have provider delivery receipts.
error
: Undelivered
Messages with failed or missing provider delivery receipts.
modified
: Texter Modified
Texter-modified messages that require admin approval.
dailycap
: Dailycapped
Messages not delivered due to exceeding the daily cap.
unreachable
: Unreachable
Messages not delivered due to an error skip condition.
nocarrier
: Carrier Skip
Messages not delivered due to a carrier skip condition.
expired
: Expired
Mssages not delivered due to an invalid time range.
replies
: All Replies
Messages with contact replies, including those system-filtered as opt-outs.
curl -XPOST -u CID:KEY -d 'title=Download Contacts&msgtime=1753630726743' https://app.rumbleup.com/api/report/create
Response:
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Download Contacts",
"title": "Download Contacts",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "msgtime": 1753630726743 },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
title
: (required, string) Project Stats
gid
: (optional, list) Group ID.owner
: (optional, bool) Owner flag to pull subaccount projects in addition.name
: (optional, string) Project Name Filterq
: (optional, string) General query filter for all fieldsmms
: (optional, bool) Flag to include MMS messages.sms
: (optional, bool) Flag to include SMS messages.tcr
: (optional, bool) Flag to include TCR messages.notcr
: (optional, bool) Flag to exclude TCR messages.timefields
: (optional, list) Fields to apply time-based filtering (applies to days
, since
, and before
)
p2pt_msgtime
- Last message timeok_time
- Made Live Timetest_time
- Last Test Message Sent Timemtime
- Last Modified Timedays
: (optional, int) Number of days to include in the report. (Default 1 day)since
: (optional, mtime) Start time for filtering, formatted as mtime.before
: (optional, mtime) End time for filtering, formatted as mtime.file
: (optional, bool) Flag to indicate whether to generate the report as a file.status
: (optional, list) Project status.
test
: Testingok
: Livehidden
: Archivedreview
: Draftflags
: (optional, list) Filter projects including tag.
evideo
: Enhanced Video Projectoutsourced
: Outsource Projectfullservice
: Fullservice Projectnoflags
: (optional, list) Filter projects excluding tag.action
: (optional, list) List of actions to include in the report.ctime
: (optional, list) Creation time filter, range or single value to use current date as end.mtime
: (optional, list) Modification time filter, range or single value to use current date as end.ok_time
: (optional, list) Filter based on made live time, range or single value to use current date as end.noclicks
: (optional, bool) Flag to exclude records with clicks.Basic Request (all project in the last 24 hours):
curl -XPOST -u CID:KEY -d 'title=Project Stats' https://app.rumbleup.com/api/report/create
Response:
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Project Stats",
"title": "Project Stats",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
Projects that have sent a message in the last 7 days:
curl -XPOST -u CID:KEY -d 'title=Project Stats&days=7' https://app.rumbleup.com/api/report/create
Response:
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Project Stats",
"title": "Project Stats",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "days": 7 },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
All EVT projects this year:
curl -XPOST -u CID:KEY -d 'title=ProjectStats&since=01-01-2024&flags=evideo' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Project Stats",
"title": "Project Stats",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": {
"since": "01-01-2024",
"flags": "evideo"
},
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
This report breaks down projects costs for a period of time.
title
: (required, string) Project Costs
since
: (optional, timestamp) Start timestamp for filtering.before
: (optional, timestamp) End timestamp for filtering.Projects that have sent a message in the last 7 days:
curl -XPOST -u CID:KEY -d 'title=ProjectCosts&days=7' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Project Costs",
"title": "Project Costs",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "days": 7 },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
This report provides a list of all charges associated with TCR registrations.
title
: (required, string) TCR Charges
since
: (optional, timestamp) Start timestamp for filtering.before
: (optional, timestamp) End timestamp for filtering.owner
: (optional, Boolean) Include charges from all sub-accountscurl -XPOST -u CID:KEY -d 'title=TCR Charges&since=2025-01-01%2012:00:00&owner=1' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "TCR Charges",
"title": "TCR Charges",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "since": "2025-01-01 12:00:00", "owner": 1 },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
Texters stats are recorded every week. Select a range of weeks to see their total stats.
title
: (required, string) Texter Stats
sdate
: (optional, date) Start date for filtering.edate
: (optional, date) End date for filtering.curl -XPOST -u CID:KEY -d 'title=Texter Stats&sdate=2025-05-01&edate=2025-05-10' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Texter Stats",
"title": "Texter Stats",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "sdate": "2025-05-01", "edate": "2025-05-10" },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
This report provides send & billing totals on all your associated sub-accounts.
title
: (required, string) Owner Stats
curl -XPOST -u CID:KEY -d 'title=Owner Stats&attach=1' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Owner Stats",
"title": "Owner Stats",
"interval": 0,
"attach": true,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
This report provides a breakdown of all contacts who clicked on a Click Tracking Enabled Link and how many times they clicked that link. Includes project number the link was texted in.
title
: (required, string) Clicks
since
: (optional, timestamp) Start timestamp for filtering.before
: (optional, timestamp) End timestamp for filtering.action
: (list) Contacts contacted in the provided list of actions(projects) to include in the report, also support ranges in the format NUM1-NUM2.curl -XPOST -u CID:KEY -d 'title=Clicks&action=1,2-5' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Clicks",
"title": "Clicks",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "action": "1,2-5" },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
- `title`: (required, string) Title of stripe report, either `Charges` or `Invoices`
curl -XPOST -u CID:KEY -d 'title=Charges' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "Charges",
"title": "Charges",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}
This report contains responses to questions you automated using the “Conversation Automation” tool. Report will only include answers you specified as valid answers and filters out extraneous responses.
- `title`: (required, string) Title of the report
- `action`: (list) Contacts contacted in the provided list of actions(projects) to include in the report, also support ranges in the format NUM1-NUM2.
Survey Answers:
curl -XPOST -u CID:KEY -d 'title=Survey&action=1,2-5' https://app.rumbleup.com/api/report/create
Response
{
"cid": "c_8abe4338801714749b9df6c2",
"rpid": "3632969b4e8b42ffbdb37b9da1c3d978",
"report": "TCR Charges",
"title": "TCR Charges",
"interval": 0,
"requested_by": {
"id": "api",
"name": "api"
},
"query": { "action": "1,2-5" },
"files": [],
"create_time": "07/27/2025 12:46pm CDT",
"update_time": "07/27/2025 12:46pm CDT",
"account": {
"id": "api",
"name": "api"
},
"ctime": 1753634774637,
"mtime": 1753634774637
}