Home

For Developers

Help Docs Developer Resources Report API Report Types

Report Types

P2PT Report Types

This section outlines the different variants of reports generated by the “p2pt” report type, each customized based on the specific title provided.

For details on how to run reports using the API, see Report API.

Conversations

Parameters

  • title: (required, string) Title of p2pt report, in this case 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: Pair of timestamps 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 time.

  • out_mtime: (bigint) Filter by contact outbound message time.

  • 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.

Basic Request Example

{
    "type": "p2pt",
    "title": "Conversations",
    "filter": "all",
    "action": "1,2,3,8,9,12-55",
    ... more params
}

Project Stats

Parameters

  • title: (required, string) Title of p2pt report, in this case Project Stats
  • gid: (optional, list) Group ID.
  • owner: (optional, bool) Owner flag to pull subaccount projects in addition.
  • name: (optional, string) Project Name Filter
  • q: (optional, string) General query filter for all fields
  • mms: (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 time
    • ok_time - Made Live Time
    • test_time - Last Test Message Sent Time
    • mtime - Last Modified Time
  • days: (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: Testing
    • ok: Live
    • hidden: Archived
    • review: Draft
  • flags: (optional, list) Filter projects including tag.
    • evideo: Enhanced Video Project
    • outsourced: Outsource Project
    • fullservice: Fullservice Project
  • noflags: (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.

Examples

Basic Request (all project in the last 24 hours):

{
    "type": "p2pt",
    "title": "Project Stats",
    "action": "1"
}

Project that have sent a message in the last 7 days:

{
    "type": "p2pt",
    "title": "Project Stats",
    "days": 7,
    "timefields": ["p2pt_msgtime"]
}

All EVT projects this year:

{
    "type": "p2pt",
    "title": "Project Stats",
    "since": "01-01-2024",
    "flags": ["evideo"]
}

Stripe Report Types

Parameters

- `title`: (required, string) Title of stripe report, either `Charges` or `Invoices`

Examples

Stripe Charges:

{
    "type": "stripe",
    "title": "Charges"
}

Stripe Invoices:

{
    "type": "stripe",
    "title": "Invoices"
}

Survey Report Types

Parameters

- `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.

Examples

Survey Answers:

{
    "type": "survey",
    "title": "My Survey",
    "action": "1
}