DocumentationUser GuideDeveloper GuideAPITechnology Partners
For Marketers
GO TO CONSOLECONTACT US !

Glossary

Suggest Edits

App Push/WebPush

Statistics/AppPush-WebPush

Statistics by date

  • platformGroup: Platform where the push was sent: Android, Harmony, iOS, Web, Safari.
  • statsDate: Date (Day/Month/Year) when the push was sent.
  • numDevicesSent: Number of devices where the push was sent.
  • numDevicesSuccess: Number of devices where the push was received.
  • numDevicesClicked: Number of devices where the push has been clicked.

Statistics by device

  • applicationId: Id of project.
  • campaignId: Id (generated automatically) of campaign.
  • campaignName: Name of campaign.
  • campaignCreatedAt: Date of campaign creation (Year-Month-Day T Hour,Minute,Seconds,MillisecondsZ). The Z indicates the time difference from UTC (ISO 8601).
  • campaignUpdatedAt: Date of campaign updation (Year-Month-Day T Hour,Minute,Seconds,MillisecondsZ). The Z indicates the time difference from UTC (ISO 8601).
  • platformsCampaign: It indicates the platform: Android, Harmony, iOS, Web, Safari.
  • devicePlatform: It indicates what platform works on the device where the push was received. Only 1 option (Android, Harmony, iOS, Web, Safari).
  • sendingId: Id (generated automatically) of sending.
  • sentAt: Date when notification was sent (Year-Month-Day T Hour,Minute,Seconds,MillisecondsZ). The Z indicates the time difference from UTC (ISO 8601).
  • deliveredAt: Date when notification was received (Year-Month-Day T Hour,Minute,Seconds,MillisecondsZ). The Z indicates the time difference from UTC (ISO 8601).
  • deviceId: Id of device.
  • clickedAt: Date when any link of notification was clicked (Year-Month-Day T Hour,Minute,Seconds,MillisecondsZ). The Z indicates the time difference from UTC (ISO 8601).
  • clickedButton: It indicates what link has been clicked: 0 (body), 1 (button 1) and 2 (button 2). If the field is empty, the notification has not been clicked.
  • buttonName: Button text.
  • providerStatus: Each push notification is sent through a service provider (for example, for iOS, the provider is Apple). It indicates the status received from the provider about the push sending. If it is True, all is good; if it is False, there is any error.
  • providerResponse: If the providerStatus is True, this field is empty. If the providerStatus is False, this field indicates what type of error.

Statistics by campaign

  • name: Name of campaign.
  • campaignId: Id (generated automatically) of campaign.
  • createdDate: Date when the push was sent (Year-Month-Day T Hour,Minute,Seconds,MillisecondsZ). The Z indicates the time difference from UTC (ISO 8601).
  • platformGroup: Platform where the push was sent (Android, Harmony, iOS, Web, Safari).
  • id: Id (generated automatically) of push.
  • sendingTrigger: It defines the type of sending. There are 5 options: CUSTOMER_SERVICE (the push is part of a customer journey), AUTOMATISM (the push is sent automatically after any event), IMMEDIATE (the push is sent immediately), SCHEDULED (the push is sent at a specific time or after a time interval) and SMART_TIME (the push is sent with the Best Moment option).
  • sendingGroupMode: GROUPED and UNGROUPED (Any non-grouped sending: bulk mailings, A/B TEST).
  • cancelled: It indicates the push has been canceled. If it is empty, the push was sent.
  • actionType: It defines what type of action is requested: APP (Deep linking) / URL (Open url) / CALL (Call to phone number) / MARKET (Open apps market) / SHARE (Share content) / NO_ACTION (No action) / WALLET (Download wallet).
  • actionTarget: It indicates the specific URL address of the action.
  • numDevicesSent: Number of devices where the push was sent.
  • numDevicesSuccess: Number of devices where the push was received.
  • numDevicesClicked: Number of devices where the push was clicked.
  • numDevicesClickedButtons: Number of devices where the user has clicked a button. For example, "{""0"":4}" indicates that the link of body (0) was clicked 4 times. Numbers (1 and 2) identify the link of the button 1 and the button 2 respectively.

inApp/inWeb

Statistics/inApp-inWeb

  • id: Id (generated automatically) of campaign.
  • versionId: Id (generated automatically) of campaign version.
  • version: Number of campaign versions. Indicate how many times it has been edited.
  • name: Name of campaign.
  • statsDate: Date of the publication (Day/Month/Year).
  • platformGroup: Platform where inApp/inWeb was created to publish (Android, Harmony, iOS, Web, Safari).
  • numDevicesSent: Number of devices where communication was published.
  • numDevicesClicked: Number of devices where communication was clicked.

E-mail

Statistics/Email

  • ID: Id (generated automatically) of the campaign.
  • Date: Date of the campaign.
  • Campaign: Name of campaign.
  • Sent: Number of devices where the email was sent.
  • Clicked: Number of devices where the email was clicked.
  • Opened: Number of devices where the email was opened.
  • Failed: Number of devices where the email wasn´t received.
  • CTR: Click-through rate. % of users who clicked on the email.

Chat

Statistics/Chat

  • messageId: Id (generated automatically) of message.
  • messageDate: Date of message (Year-Month-Day T Hour,Minute,Seconds +Milliseconds)
  • sendType: Type of message. It was done by the USER / OPERATOR / AGENT_NOTIFICATION (automatism) / PROACTIVE
    • input: All user input messages that arrive to our systems.
    • dialogflow: Answers generated automatically by DialogFlow
    • dialogflow_welcome: Responses generated from the invocation of the welcome event in dialogflow.
    • operator: Manual operator messages.
    • refresh_window: (where messages are free) to try to refresh the message window by responding.
    • get_language: Messages sent to the user to indicate the language with which they wish to interact.
    • agent_notification: Notification of any change: agent assignment, conversation closing, etc.
    • webchat_welcome: Message automatically sent when a user starts a conversation through a web chat.
    • proactive: Proactive messages.
  • contentType: Type of content.
    • text: text content.
    • image: image content.
    • audio: audio content.
    • video: video content.
    • document: document content like pdf, xlsx, doc, ppt, etc.
    • interactive: messages clickable by the final user (buttons, list, single and multi product list).
    • quickReplyEvent: users action in an interactive message.
    • template: Meta template (only for Whatsapp and Messenger channel).
  • status: Sent. If there is any error, the field is empty.
  • statusAt: Date of status (Year-Month-Day T Hour,Minute,Seconds +Milliseconds)
  • channelExternalId: Internal identifier used by indigitall for each channel.
  • error: It indicates the error name. If all is good, the field is empty.
  • content: Content of message.
  • scheduleAt: Date of message is scheduled (Year-Month-Day T Hour,Minute,Seconds +Milliseconds).
  • integration: It indicates that the interaction is done by Agent (people) or Dialog Flow (bot).
  • channel: What channel is used for communications: WhatsApp / Webchat / AppChat / Messenger.
  • profileName: Profile name of user using WhatsApp.
  • contactId: Id of contact.
  • agentConversationId: Id of the interaction between user and agent.
  • agentQueuedAt: Date when it is requested the redirection for an agent (Year-Month-Day T Hour,Minute,Seconds +Milliseconds).
  • agentAssignedAt: Date of assignment for an agent (Year-Month-Day T Hour,Minute,Seconds +Milliseconds).
  • agentClosedAt: Date to close the case (Year-Month-Day T Hour,Minute,Seconds +Milliseconds).
  • agentCloseReason: Reason to close the case.
  • agentId: Id of agent.
  • dfIntentId: Id of each menu option (bot).
  • dfIntentName: Name of each menu option (bot).
  • isFallback: The user writes something that bot is not configured to answer.

SMS

Statistics/SMS

  • ID: Id (generated automatically) of the campaign.
  • Date: Date of the campaign.
  • Campaign: Name of campaign.
  • Sent: Number of devices where the SMS was sent.

Export devices

Audiences/AppPush-WebPush/Export Devices

  • createdAt: Date of creation in our database (Year,Month,Day Hour,Minutes,Seconds, Milliseconds, in reference to UTC).
  • updatedAt: Date of updating in our database (Year,Month,Day Hour,Minutes,Seconds, Milliseconds, in reference to UTC).
  • deviceId: Unique identifier of device for app push and web push notifications.
  • externalCode: Unique identifier of device for all channels.
  • pushToken: Unique identifier given by push providers (Apple, Google, Chrome…) that we use to interact with the device via push notifications.
  • enabled: If it is available, the field shows True.
  • platform: It defines the device platform: iOS, Android or Web.
  • operator: It defines the device operator.
  • sdkVersion: The SDK version of the device implemented by the client to send pushes.
  • osName: Operating system of device.
  • osVersion: Version of the operating system.
  • deviceBrand: Brand of device (for example, Apple, Motorola).
  • deviceModel: Model of device.
  • browserName: Name of the device browser.
  • browserVersion: Version of the browser.
  • origin: URL where the user request of web push is recorded on the client side.
  • deviceType: Type of device: Mobile or desktop.
  • locale: Language of device.
  • timeOffset: It specifies the zone offset from UTC.
  • timeZone: Geographical time area of device.
  • productName: SDK implemented to integrate all communications for the device.
  • productVersion: SDK version used for the integration.
  • pushError: Explanation about the error in push delivery (for example, unregistered, unsubscribed, subscription expired). It is an optional field; it appears when there is any error.
  • appVersion: Version of App installed on device.
  • lastPushErrorAt: Date of the last error in push delivery (Year,Month,Day Hour,Minutes,Seconds, Milliseconds, in reference to UTC).

Updated over 1 year ago