Giosg Developer Documentation

Introduction

Welcome to the giosg API documentation!

Here you can find API documentation of our endpoints and guides how to use them. These endpoints can be used for multiple purposes in your application.

Sections

Changelog

29.01.2020 Added Chat Sessions API
28.01.2020 Updated Visitor Sessions API
23.01.2020 Added Uploads API.
10.01.2019 Update Conversation & visitor data encryption. guide
15.01.2020 Added new filters for user chat message list APIs
09.01.2019 Add new preview_is_logo field for Link preview api.
08.01.2020 Added new filters for Involved/Owned chat message list APIs
10.12.2019 Added Link preview api.
28.11.2019 Added Two new rule actions.
19.11.2019 Added notification about max 2 decimals support to Basket API.
18.11.2019 Added last_seen_at field for Chat Membership API and Visitor Chat Membership API.
06.11.2019 Added Implementing custom chat client
31.10.2019 Added Visitor chat memberships API
21.10.2019 Added ui_version field for Organization Settings.
17.10.2019 Added User chat statistics API v3
16.10.2019 Added Organization chat statistics API v3
16.10.2019 Fixed incorrectly formatted json in rich chat attachments guide.
07.10.2019 Added Organization allowed tags API.
02.10.2019 Added Visitor Sessions API
24.09.2019 Added datetime filter for Chat APIs
19.09.2019 Added Weekly experiment results v3 API description.
05.09.2019 Added is_draft, rooms and room_ids attributes for Experiment and updated optional, required and read-only attributes to Experiments API
28.08.2019 Fixed minor mistake in Organization API documentation.
26.08.2019 Added one missing and one new Rule conditions.
26.08.2019 Added authentication section to guides
13.08.2019 Added “organization level user preferences” documentation to Retrieve an organization users preferences
25.06.2019 Fixed issues with external and interaction attachment documentation.
19.06.2019 Added “external attachment” documentation to Chat Message Attachment HTTP API reference and updated Chat Message Attachment Guide accordingly.
18.06.2019 Added info about interaction attachment parameters.
17.06.2019 Updated Basket API
05.06.2019 Updated Experiments API
05.06.2019 Added update API documentation for organization’s single owned chat. This endpoint can now be used to end chats.
03.06.2019 Added “interaction attachment” documentation to Chat Message Attachment HTTP API reference and updated Chat Message Attachment Guide accordingly.
29.05.2019 Fixed Weekly experiment results v2 API description.
10.05.2019 Added is_created_by_sso field as User’s attribute.
08.05.2019 Added Rules API.
06.05.2019 Added supported browsers
16.04.2019 Updated basket configuration guide
10.04.2019 Single sign-on Authentication Flow added to Authentication section.
26.03.2019 Fixed remark on available user permissions for bot users.
20.03.2019 Added API for scheduling removal of visitor’s data.
01.03.2019 Renamed Visitor data API to Visitor variable API
28.02.2019 Removed Rules API draft from documentation.
27.02.2019 Added cart_count field to Organizations and user chat statistics API endpoints.
26.02.2019 Changed cookie lifetimes set by Giosg from 10 years to 2 years.
19.02.2019 Added 409 response status when creating a new public chat message and fixed 409 response status for creating a new chat message for user’s chat if chat is ended.
15.02.2019 Added id field to app installation and updated URL scheme for app installation related API endpoints
15.02.2019 Added new trigger condition “uninstall” Apps API’s supported trigger conditions and updated Apps guide’s trigger conditions.
29.01.2019 Added Organization Customership API.
24.01.2019 Added create and update APIs for room visitor.
24.01.2019 Added chat_type field to Chat APIs and Public Chat APIs.
03.01.2019 Added new response status 402 for owned app update API and owned app sharing API
31.12.2018 Added installation_count field to public apps APIs, partner apps APIs, owned apps APIs and installed apps APIs.
28.12.2018 Added required_scopes, allowed_scopes and is_app_user_required fields to apps APIs.
28.12.2018 Added description for giosg app permissions.
28.12.2018 Added outgoing chat invitation expire API.
27.12.2018 Added new fields sales_with_chat, sales_with_real_conversation, chats_with_sales_count, and real_conversations_with_sales_count to Real-time reporting API.
20.12.2018 Fixed a link in Visitor chat widget section.
20.12.2018 Authorization Code Grant Flow support added to giosg apps’ [how to get persistent access token for bot user].(./giosg_apps.html#persistent-access-tokens-for-bot-users) and differentiate bot user use cases for reacting and performing actions requiring permissions.
20.12.2018 Authentication section improved to include more about Authorization Code Grant Flow.
04.12.2018 Added allowed_redirect_uris field to Owned app.
26.11.2018 Added new identity endpoint: Token endpoint.
26.11.2018 Added new trigger condition for giosg apps.
26.11.2018 Added Endpoints API.
26.11.2018 Added section about online status to the Chatbots guide.
26.11.2018 Added retrieve a user API, update a user API, and other minor updates.
14.11.2018 Added information about maximum lengths to Organization API fields.
02.11.2018 Modified External goal match API to require a list of room UUID’s for the goal.
30.10.2018 Added Weekly experiment results v2 API Deprecated Weekly cumulated experiment results API v1.
10.10.2018 Added support for anchor links as value of Chat message attachment actions.
10.10.2018 Updated giosg BASKET configuration guide.
27.09.2018 Major updates to the giosg apps development guide and chatbot development guide.
27.09.2018 Added API for retrieving details of user’s routed chat.
25.09.2018 Added Sharing APIs.
24.09.2018 Added API for retrieving details of user’s room.
24.09.2018 Added room_id field to Chat message APIs.
19.09.2018 Added list of Giosg’s public IP addresses
30.08.2018 Added routed chats support Chat reply suggestion APIs.
30.08.2018 Added API for listing User’s routed chat’s messages.
30.08.2018 Added API for joining User’s routed chat.
30.08.2018 Added API for listing User’s routed chat’s memberships.
29.08.2018 Added documentation for email field to be nullable for bot users in Users API.
28.08.2018 Added new fields app_user_default_first_name, app_user_default_last_name, and app_user_default_alias to Owned Apps section.
24.08.2018 Added is_bot field as User’s attribute.
24.08.2018 Added a lot of new APIs to giosg Apps section.
10.08.2018 Added brand_primary and brand_secondary as supported styles for Chat message attachment actions.
10.07.2018 Added organization field for Partnership.
06.07.2018 Added Room and organization level API’s for quarter hour user activity stats.
26.06.2018 Added is_swimlane_visible field for User preferences.
19.06.2018 Added User permission API endpoints, added required permissions for existing HTTP APIs, and API permissions cheat sheet. User’s is_manager attribute is now a deprecated field and has no impact.
18.06.2018 Added max_rules_count field to Organization.
18.06.2018 Added Organization User Team API.
13.06.2018 Added room_id to Public Chat Tag API.
12.06.2018 Timezone support added for Organizations and user chat statistics reporting API
31.05.2018 Added Organization Room RoomChatTag API.
30.05.2018 Updated email, first_name and last_name fields of Users. email changed from read-only to required. first_name and last_name now accept empty strings.
30.05.2018 Added password_expiration_days field for Organization Settings.
30.05.2018 Added deleted_at field for Users.
25.05.2018 Added hashed_name attribute to */allowed_tags endpoints in Chat tag API.
22.05.2018 Added documentation for Public Chat Tag API.
16.05.2018 Added sensitive_data_purged_at field for Leads.
15.05.2018 Added draft documentation for Authentication with OAuth2 flows.
07.05.2018 Renamed Goal match API to External Goal match API to prevent confusion with similarly named javascript API.
02.05.2018 Added documentation for Organizations and user chat statistics reporting API
20.04.2018 Added documentation for Visitor chat widgets.
18.04.2018 Added Organization Brand delete API endpoint.
17.04.2018 Added API for fetching rooms which use given brand.
17.04.2018 Updated Public Room API documentation with Brand related fields.
11.04.2018 Added Organization Brand API endpoints.
23.03.2018 Added Organization owned/involved chat visitor variable API endpoints.
19.03.2018 Added User routed chats List API endpoint.
16.03.2018 Documented 409 HTTP status for joining pending chats.
02.03.2018 Added Organization overview.
27.02.2018 Added List users of a room API.
02.03.2018 Added Real-time reporting API to Reporting API.
23.02.2018 Added Organization user delete API to User API.
20.02.2018 Dropped support for the GCM.
09.02.2018 Described the possibility of race conditions when implementing chat bots to the Bot guides.
06.02.2018 Added system messages and for Chat API & Public Chat API.
26.01.2018 Added duration and active_duration for Chat API.
12.01.2018 Added scheduled-email-reporting-api draft.
27.12.2017 Added is_waiting and waiting_started_at for Chat API.
22.12.2017 Added documentation for Room Online Times API
21.12.2017 Added documentation for Scheduled Email Reporting API
04.12.2017 Improved chat routing system description in the Router API documentation
27.11.2017 Added Giosg App API to apps API.
22.11.2017 Changed type of in Routing precondition object from task_waited_in_previous_step to task_waited.
17.11.2017 Added Organization user create API to User API.
13.11.2017 Added API for fetching rooms which use given router
06.11.2017 Added router_id for organization room settings.
31.10.2017 Added Organization chat tag APIs
30.10.2017 Added documentation for new Timezones API and updated Organization Settings API documentation with timezone field.
24.10.2017 Added a preview draft documentation of the upcoming Real-time API.
22.09.2017 Changed duration format in Ban object from minutes to seconds.
07.09.2017 Removed not implemented warnings from Team and from Team membership APIs.
04.09.2017 Removed Sharing API draft.
01.09.2017 Added Router API draft.
28.08.2017 Added description of How Giosg script works?.
19.08.2017 Added hourly chat statisticss API to reporting API.
17.08.2017 Added documentation for organization room settings.
16.08.2017 Allow defining the charset attribute for uploaded assets.
08.08.2017 Added a script_tag attribute to organizations, and added an endpoint for updating organization settings.
04.08.2017 Added a new field referencing the selected chat reply suggestion to chat messages.
05.07.2017 Added hourly visitor device stats to reporting API.
21.06.2017 Asset update now allows replacing uploaded file with a new one.
08.06.2017 Added Chat Message Attachment HTTP API reference, endpoint API reference for Replying to Chat Message Attachment and Chat Message Attachment Guide.
01.06.2017 Updated some terms used in the document.
01.06.2017 Visitor variable create APIs return now only 201 and never 200
01.06.2017 Added supported languages API. ISO 639-1 format deprecated, switched to RFC 3066 format.
31.05.2017 name is required field for Organization.
31.05.2017 Renamed Leads API and divided Customer API to Organization and User APIs.
31.05.2017 Added new endpoints for joining involved chat, listing involved chat’s messages.
23.05.2017 Updated cookie information page with more detailed explanation of cookie usage. Cookies.
23.05.2017 Changed maximum time range limit on reporting API’s Time ranges.
22.05.2017 Enhanced Goal documentation by adding link to JS API. Goals.
15.05.2017 Added Organization settings API documentation.
10.05.2017 The deprecated field user_count is now removed from the Canned Answers.
04.05.2017 Added Visitor ban API documentation.
21.04.2017 Added filtering by description for Assets.
21.04.2017 Updates to End a chat API documentation. Updating chat with is_ended parameter as false now changes is_waiting to be false also.
20.04.2017 Fixed misinformation in Visitor Chat Membership APIs.
19.04.2017 Modified former treatment reporting API to Rule Reporting API. Renamed a lot of fields. Removed unused touched by giosg API.
18.04.2017 Updated missing token attribute in Authentication API Documentation.
13.04.2017 Added Avatar API documentation.
13.04.2017 Added retrieve API documentation for organization’s single owned chat and involved chat.
05.04.2017 Added Experiment results API documentation.
05.04.2017 Added Target and TargetExperiment API.
05.04.2017 Added Experiments API.
29.03.2017 Fixed is_deleted parameter explanation in listing organization users.
29.03.2017 Added new field sensitive_data_purged_at for chat messages.
28.03.2017 Added documentation for new visitor variable endpoints which are now organization prefixed.
18.03.2017 Added Delete existing visitor variable API documentation.
17.03.2017 Added 409 response when creating a new chat with visitor, if someone else already has a chat with the visitor.
15.03.2017 Added new field room_organization_id for Chats and new fields chat_created_at, member_organization_id and room_organization_id for ChatMemberships.
10.03.2017 Fixed Create chat visitor variable which stated incorrectly how to create/update chat visitor variables.
06.03.2017 Added Added Chat stats API documentation.
23.02.2017 Chat reply suggestion’s relevancy_score is now optional.
23.02.2017 Fixed Visitor search terms API documentation documentation which stated incorrectly that unique visitors were calculated while it.
22.02.2017 Added Added User activity stats API documentation.
21.02.2017 Added Visitor Traffic sources report.
14.02.2017 Updated Goal match API description.
09.02.2017 Added new filtering options for listing Chats (has_messages, has_user_messages and has_visitor_messages) and new fields for Chats.
09.02.2017 Added Visitor’s chat memberships API documentation.
07.02.2017 Added Visitor search terms API documentation.
07.02.2017 Removed admin_count field from Teams and is_admin field from Team membership.
02.02.2017 Fixed GET /api/v5/orgs/<organization_id>/assigned_leads/<lead_id> to the right format: GET /api/v5/orgs/<organization_id>/leads/<lead_id>.
02.02.2017 Fixed POST /api/v5/orgs/<organization_id>/users/<user_id>/chats/<chat_id>/messages to the right format: POST /api/v5/users/<user_id>/chats/<chat_id>/messages.
02.02.2017 Fixed GET /api/v5/orgs/<organization_id>/rooms/<room_id>/chats/<chat_id>/messages URL to the right format: GET /api/v5/orgs/<organization_id>/chats/<chat_id>/messages.
27.01.2017 Added two new cookies: giosg_sgid_{$COMPANY_ID} and giosg_gsessid_{$COMPANY_ID}.
26.01.2017 Changed is_online_enabled field to be required for Users.
23.01.2017 Added Visitor geo stats API section.
20.01.2017 Added Isp pageviews API documentation.
18.01.2017 Added Bot guides.
18.01.2017 Added Guides section.
16.01.2017 Added API documentation for listing Chat’s reply suggestions.
10.01.2017 Added Chat reply suggestion APIs.
30.12.2016 Added change log to documentation.