# Iterable: Campaigns ## Description * Table that provides aggregations for campaigns at the experiment grain. ## Supported Data Sources * Iterable ## Columns | Type | Name | Description | | -------- | ------------------------------- | -------------------------------------------------------------------------------------------------------- | | STRING | campaign\_id | Unique identifier of the campaign record | | STRING | campaign\_name | User defined name of the campaign. | | DATETIME | updated\_at | Last update timestamp as epoch time in milliseconds | | STRING | campaign\_state | State of the campaign. Can be Draft, Ready, Scheduled, Running, Finished, Starting, Aborted or Recurring | | STRING | campaign\_type | The campaign type. Can be Blast or Triggered | | INTEGER | send\_size | Size of the campaign. Number of individuals included in the campaign | | DATETIME | start\_at | Start timestamp as epoch time in milliseconds | | DATETIME | ended\_at | Ended timestamp as epoch time in milliseconds | | DATETIME | created\_at | Creation timestamp as epoch time in milliseconds | | STRING | created\_by\_user\_id | Reference to the user who created the campaign | | STRING | template\_id | Reference to the campaign template | | STRING | recurring\_campaign\_id | Unique identifier of the recurring campaign (if applicable) | | STRING | recurring\_campaign\_name | Name of the recurring campaign (if applicable) | | STRING | recurring\_campaign\_state | State of the recurring campaign (if applicable) | | INTEGER | recurring\_campaign\_send\_size | Size of the recurring campaign. Number of individuals included in the recurring campaign (if applicable) | | DATETIME | recurring\_campaign\_start\_at | Timestamp of when the recurring campaign started (if applicable) | | BOOLEAN | is\_campaign\_recurring | Boolean indicating if the campaign is a recurring campaign | | STRING | experiment\_id | Reference to the experiment used if the event is an experiment | | INTEGER | count\_unique\_users | Count of total unique users within the campaign/experiment | | INTEGER | total\_emailclick | Total email clicks within the campaign/experiment | | INTEGER | unique\_total\_emailclick | Unique email clicks within the campaign/experiment | | INTEGER | total\_emailunsubscribe | Total email unsubscribe events within the campaign/experiment | | INTEGER | unique\_total\_emailunsubscribe | Unique total email unsubscribe events within the campaign/experiment | | INTEGER | total\_emailcomplaint | Total email complaints within the campaign/experiment | | INTEGER | unique\_total\_emailcomplaint | Unique total email complaints within the campaign/experiment | | INTEGER | total\_customevent | Total custom events within the campaign/experiment | | INTEGER | unique\_total\_customevent | Unique total custom events within the campaign/experiment | | INTEGER | total\_emailsubscribe | Total email subscribe events within the campaign/experiment | | INTEGER | unique\_total\_emailsubscribe | Unique total email subscribe events within the campaign/experiment | | INTEGER | total\_emailopen | Total email open events within the campaign/experiment | | INTEGER | unique\_total\_emailopen | Unique total email open events within the campaign/experiment | | INTEGER | total\_pushsend | Total push send event within the campaign/experiment | | INTEGER | unique\_total\_pushsend | Unique total push send events within the campaign/experiment | | INTEGER | total\_smsbounce | Total sms bounce events within the campaign/experiment | | INTEGER | unique\_total\_smsbounce | Unique total sms bounce events within the campaign/experiment | | INTEGER | total\_pushbounce | Total push bounce events within the campaign/experiment | | INTEGER | unique\_total\_pushbounce | Unique total push bounce events within the campaign/experiment | | INTEGER | total\_inappsendskip | Total in app send skip events within the campaign/experiment | | INTEGER | unique\_total\_inappsendskip | Unique total in app send skip events within the campaign/experiment | | INTEGER | total\_smssend | Total sms send events within the campaign/experiment | | INTEGER | unique\_total\_smssend | Unique total sms send events within the campaign/experiment | | INTEGER | total\_inappsend | Total in app send events within the campaign/experiment | | INTEGER | unique\_total\_inappsend | Unique total in app send events within the campaign/experiment | | INTEGER | total\_pushopen | Total push open events within the campaign/experiment | | INTEGER | unique\_total\_pushopen | Unique total push open events within the campaign/experiment | | INTEGER | total\_emailsend | Total email send events within the campaign/experiment | | INTEGER | unique\_total\_emailsend | Unique total email send events within the campaign/experiment | | INTEGER | total\_pushsendskip | Total push send skip events within the campaign/experiment | | INTEGER | unique\_total\_pushsendskip | Unique total push send skip events within the campaign/experiment | | INTEGER | total\_inappopen | Total in app open events within the campaign/experiment | | INTEGER | unique\_total\_inappopen | Unique total in app open events within the campaign/experiment | | INTEGER | total\_emailsendskip | Total email send skip events within the campaign/experiment | | INTEGER | unique\_total\_emailsendskip | Unique total email send skip events within the campaign/experiment | | INTEGER | total\_emailbounce | Total email bounce events within the campaign/experiment | | INTEGER | unique\_total\_emailbounce | Unique total email bounce events within the campaign/experiment | | INTEGER | total\_inappclick | Total in app click events within the campaign/experiment | | INTEGER | unique\_total\_inappclick | Unique total in app click events within the campaign/experiment | | INTEGER | total\_pushuninstall | Total push uninstall events within the campaign/experiment | | INTEGER | unique\_total\_pushuninstall | Unique total push uninstall events within the campaign/experiment | | INTEGER | count\_send\_lists | Count of send lists within the campaign/experiment | | INTEGER | count\_suppress\_lists | Count of suppress lists within the campaign/experiment | | STRING | template\_name | Name of the template associated with the campaign/experiment | | STRING | template\_creator\_user\_id | The creator user id of the template associated with the campaign/experiment | | STRING | message\_medium | The medium which the message was provided | | STRING | message\_type\_name | The message type name associated with the campaign/experiment | | STRING | channel\_name | The channel name associated with the campaign/experiment | | STRING | channel\_id | The channel identifier associated with the campaign/experiment | | STRING | channel\_type | The channel type associated with the campaign/experiment | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://endash-guidance-docs.gitbook.io/cigro-data-templates/data-model-templates/iterable-campaigns.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.