magnews

Search for audiences based on specified criteria, and retrieve their basic information. This tool allows to filter one or more audiences by applying a set of clauses combined using a global boolean mode (AND / OR). The result contains informational data only (no statistics). ### Query semantics - Filters are expressed as a list of clauses. - All clauses are combined using a single mode: - `MATCH_ALL`: every clause must match (logical AND) - `MATCH_ANY`: at least one clause must match (logical OR) - Mixing AND and OR within the same query is not supported. - The `SQL_LIKE` operator behaves exactly like the SQL LIKE operator, so the '%' signs must be included in the value where appropriate. ### Limits - A maximum of 100 audiences can be returned. - If `count` is not provided, the default value (100) is used. - Requests exceeding the limit are automatically capped. ### Output Returns a csv, ordered by 'lastmodificationdate' (most recent first), with the following headers: "iddatabase","idaudience","audience_name","is_static","creationdate","lastmodificationdate" If an error occurs, an error string is returned instead.

findAudiences

Search for communications based on specified criteria, and retrieve their full attributes. This tool allows to filter one or more communications by applying a set of clauses combined using a global boolean mode (AND / OR). The result contains informational data only (no statistics or performance metrics). ### Query semantics - Filters are expressed as a list of clauses. - All clauses are combined using a single mode: - `MATCH_ALL`: every clause must match (logical AND) - `MATCH_ANY`: at least one clause must match (logical OR) - Mixing AND and OR within the same query is not supported. - The `SQL_LIKE` operator behaves exactly like the SQL LIKE operator, so the '%' signs must be included in the value where appropriate. ### Limits - A maximum of 100 communications can be returned. - If `count` is not provided, the default value (100) is used. - Requests exceeding the limit are automatically capped. ### Output Returns a csv, ordered by 'sentdate' then 'creationdate' (most recent first), with the following headers: "idcommunication","name","subject","creationdate","sentdate","idjourney","idworkflow","channel","fromname","journeyname","targets" The "targets" column contains a JSON array with the audiences the communication was sent to, it is empty for communications that have never been sent. If an error occurs, an error string is returned instead. All dates must be specified in yyyy-MM-dd HH:mm:ss format.

findCommunications

Search for workflows according to specific criteria and retrieve their full attributes. This tool allows filtering one or more workflows by applying a set of clauses combined using a global boolean mode (AND / OR). The result contains informational data along with basic sessions information. ### Query semantics - Filters are expressed as a list of clauses. - All clauses are combined using a single mode: - `MATCH_ALL`: every clause must match (logical AND) - `MATCH_ANY`: at least one clause must match (logical OR) - Mixing AND and OR within the same query is not supported. - The `SQL_LIKE` operator behaves exactly like the SQL LIKE operator, so the '%' signs must be included in the value where appropriate. ### Limits - A maximum of 50 workflows can be returned. - If `count` is not provided, the default value (50) is used. - Requests exceeding the limit are automatically capped. ### Output Returns a csv, ordered by 'lastpublicationdate' (most recent first) with the following headers: "idworkflow","name","description","idjourney","journeyname","creationdate","lastmodificationdate","lastpublicationdate","totalsessions","totalactivesessions","firstsessiondate","lastsessiondate","status" Deleted workflows are not included. If an error occurs, an error string is returned instead.

findWorkflows

Retrieve a SQL-like filter definitions for more than one dynamic audience for which you already know the IDs. Use this tool when you need to understand how the requested audiences are composed, including the current audience filters and the filters inherited from parent audiences. Returns a JSON object containing a list of dictionaries, one for each requested audience, with the following information: - idAudience - audienceFilter: description of the filter directly applied to the audience - parentAudiences: list of parent audiences, each containing: - idParent - parentName - filter: description of the filter inherited from that parent audience

getAudienceFilters

Retrieve data and statistics/insight about more than one audiences for which you already know the IDs. Returns a JSON object containing a list of dictionaries with the following information about the requested audiences: idAudience, audienceName, audienceType, idDatabase, totalContacts, businessFields (label, average, ...), inRecency, engagementScore, conversions System audiences are redacted unless their system label is `subscribed`. A redacted row contains only idAudience, audienceName and a `data` field explaining that the audience is not visible to the user. All dates must be specified in yyyy-MM-dd HH:mm:ss format.

getAudiencesInsights

Retrieves the name, subject, preheader, from name, from email, text content, and a screenshot of a communication. This functionality is available only for communications sent through the `email` channel.

getCommunicationContent

Retrieve data and statistics/insight (clicks, opens, etc) about more than one communication for which you already know the IDs. Each communication can be on email or sms channel, or both. Returns a JSON object containing a list of dictionaries with information about the requested communications, along with aggregated data for all returned communications in a separate field. The response also includes statistics on communication links and conversion goals.

getCommunicationInsights

Count contacts in a database or audience, optionally filtered, and return counts grouped by subscription status. Pass either `iddatabase` or `idaudience` to count contacts in that scope. These parameters are mutually exclusive, provide at most one. You may also provide `filter`: * With `iddatabase` or `idaudience`, it further restricts contacts within that scope. * Without either, it is applied across all accessible databases. `filter` must contain only a SQL `WHERE` condition, not a complete query (e.g. "sex = 'F'"). Do not include either an `iddatabase` or `idaudience` condition, use the parameters for that. Use only contact fields returned by `getDatabaseFields`. The result contains four counts: `subscribed`, `unconfirmed`, `suspended`, and `unsubscribed`. All four keys are always present, using `0` when no contacts match. Sum them to get the total number of contacts. On failure, the tool returns an object containing only an `error` key.

getContactsCount

Retrieves basic information about a database (contact database / address book), along with its contact fields, including each field's type, label, and other attributes. Use `iddatabase = 0` to retrieve the global (shared) database fields. Set `onlyGlobal` to `true` to restrict the response to global fields only. Set `onlyBusiness` to `true` to restrict the response to business fields only. Returns a JSON object containing: * `idDatabase`: the database id * `databaseName`: the database name * `primaryKeyField`: the name of the primary-key field * field definitions, organized by category and section, including attributes such as name, label, type, subtype, global/system/business flags, and values for enum-like fields If an error occurs, an object with a single `error` key is returned.

getDatabaseFields

Retrieve data and statistics/insight (clicks, opens, etc) about more than one transactional message for which you already know the IDs. Each transactional message can be on email or sms channel, or both. Returns a JSON object containing a list of dictionaries with information about the requested communications, along with aggregated data for all returned communications in a separate field. The response also includes statistics on communication links and conversion goals. All dates must be specified in yyyy-MM-dd HH:mm:ss format.

getTransactionalMessagesInsights