Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
    • Data & Analytics
      • Anonymize a conversation or visitor data
      • Create a custom dashboard
      • Find contact data using GraphQL
      • Retrieve conversations data
      • Retrieve messages exchanged within a conversation
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (deprecated)
      • Statistic (deprecated)
      • Group (deprecated)
      • Call meeting (deprecated)
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Fourme (latest)
        • Epoisses
        • Dauphin
        • Cantal
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • List your transactions
  • Filters
  • Get a transaction details
  • Fields

Was this helpful?

  1. Technologies
  2. REST API (deprecated)

Transaction (deprecated)

PreviousSkill (deprecated)NextVisitor (deprecated)

Last updated 13 days ago

Was this helpful?

This resource is deprecated. You should consider using our GraphQL API with the Conversion or Conversions objects.

List your transactions

GET /transaction

See below to discover used fields and see to discover some output examples.

Transactions from a given day will be available on the next day after 5 am.

Filters

Filter
Description
Values
Use

website_id

Website identifier

?filters[website_id]=123

operator_id

Operator identifier

?filters[operator_id]=123

conversation_id

Conversation identifier

Conversation identifier. You can also use !null & null to filter all transactions associated or not to a conversation.

?filters[conversation_id]=123 ?filters[conversation_id]=null ?filters[conversation_id]=!null

from

Date from

YYYY-MM-DD or YYYY-MM-DD HH:MM:SS

?filters[from]=YYYY-MM-DD HH:MM:SS

to

Date to

YYYY-MM-DD or YYYY-MM-DD HH:MM:SS

?filters[to]=YYYY-MM-DD HH:MM:SS

The maximum duration allowed between from and to is 1 month.

Get a transaction details

GET /transaction/123

See to discover some output examples.

Fields

Field
Description
Values

id

Tag identifier

Integer

external_id

External identifier

String

visitor_uid

Visitor unique identifier

String

visitor_email

Visitor email

String

amount

Amount

Double

created_at

Date of creation

Date YYYY-MM-DD HH:MM:SS

website_id

Website identifier

Integer

operator_id

Operator identifier

Integer

conversation_id

Conversation identifier

Integer

reading section
reading section