journey.io
Module journey.io
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_journey.io_1.4.0.png)
ballerinax/journey.io Ballerina library
Overview
This is a generated connector for Journey.io API v1.0.0 OpenAPI specification.
The journy.io API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Prerequisites
- Create an Journey.io account
- Obtaining tokens
- Use this guide to obtain the API key related to your account
Clients![](/images/permalink.svg)
journey.io: Client![](/images/permalink.svg)
This is a generated connector for Journey.io API v1.0.0 OpenAPI specification. The journy.io API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Journy.io account and obtain the API Key following this guide.
init (ApiKeysConfig apiKeyConfig, ClientConfiguration clientConfig, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.journy.io" - URL of the target service
link![](/images/permalink.svg)
function link(LinkBody payload) returns InlineResponse201|error
Link web activity to user
Parameters
- payload LinkBody -
Return Type
- InlineResponse201|error - Object was created
trackJourneyEvent![](/images/permalink.svg)
function trackJourneyEvent(EventsBody payload) returns InlineResponse201|error
Push event
Parameters
- payload EventsBody -
Return Type
- InlineResponse201|error - Object was created
upsertUser![](/images/permalink.svg)
function upsertUser(UsersUpsertBody payload) returns InlineResponse201|error
Create or update user
Parameters
- payload UsersUpsertBody -
Return Type
- InlineResponse201|error - Object was created
upsertAccount![](/images/permalink.svg)
function upsertAccount(AccountsUpsertBody payload) returns InlineResponse201|error
Create or update account
Parameters
- payload AccountsUpsertBody -
Return Type
- InlineResponse201|error - Object was created
addUserToAccount![](/images/permalink.svg)
function addUserToAccount(string accountId, AccountidUsersBody payload) returns InlineResponse201|error
Add user to account
Parameters
- accountId string - Unique identifier for the account in your database
- payload AccountidUsersBody -
Return Type
- InlineResponse201|error - Object was created
removeUserFromAccount![](/images/permalink.svg)
function removeUserFromAccount(string accountId) returns InlineResponse201|error
Remove user from account
Parameters
- accountId string - Unique identifier for the account in your database
Return Type
- InlineResponse201|error - Object was created
getValidity![](/images/permalink.svg)
function getValidity() returns InlineResponse200|error
Validate API key
Return Type
- InlineResponse200|error - Key validation
getTrackingSnippet![](/images/permalink.svg)
function getTrackingSnippet(string domain) returns InlineResponse2001|error
Get snippet for a website
Parameters
- domain string - The domain you want to receive a snippet for
Return Type
- InlineResponse2001|error - Snippet
Records![](/images/permalink.svg)
journey.io: AccountidUsersBody![](/images/permalink.svg)
The user being added/removed from the account
Fields
- userId string - Unique identifier for the user in your database
journey.io: AccountsUpsertBody![](/images/permalink.svg)
Update properties and/or members of an account
Fields
- identification EventsIdentificationAccount - Account identification requires an accountId, domain or both
- properties record {}? - The properties being set, possible values are strings, booleans, numbers and datetimes (ISO 8601)
- members AccountsupsertMembers[]? - The users that are member of this account
journey.io: AccountsupsertMembers![](/images/permalink.svg)
Identification requires an accountId, domain or both
Fields
- identification LinkIdentification - User identification requires a userId, email or both
journey.io: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
X-Api-Key
journey.io: EventsBody![](/images/permalink.svg)
Event for a user or an account
Fields
- identification EventsIdentification - Event identification requires a user, account or both
- name string -
- metadata record {}? - Event metadata, possible values are strings, booleans, numbers and datetimes (ISO 8601)
- triggeredAt string? - If left blank this defaults to the current datetime
journey.io: EventsIdentification![](/images/permalink.svg)
Event identification requires a user, account or both
Fields
- account EventsIdentificationAccount? - Account identification requires an accountId, domain or both
- user LinkIdentification? - User identification requires a userId, email or both
journey.io: EventsIdentificationAccount![](/images/permalink.svg)
Account identification requires an accountId, domain or both
Fields
- domain string? - The domain associated with the account (e.g. acme-inc.com)
- accountId string? - Unique identifier for the account in your database
journey.io: InlineResponse200![](/images/permalink.svg)
Fields
- meta InlineResponse201Meta -
- data InlineResponse200Data - Validation of API Key
journey.io: InlineResponse2001![](/images/permalink.svg)
Fields
- meta InlineResponse201Meta -
- data InlineResponse2001Data - A snippet
journey.io: InlineResponse2001Data![](/images/permalink.svg)
A snippet
Fields
- domain string -
- snippet string -
journey.io: InlineResponse200Data![](/images/permalink.svg)
Validation of API Key
Fields
- permissions string[] -
journey.io: InlineResponse201![](/images/permalink.svg)
Fields
- meta InlineResponse201Meta -
- message string -
journey.io: InlineResponse201Meta![](/images/permalink.svg)
Fields
- requestId string -
- status decimal -
journey.io: InlineResponse400![](/images/permalink.svg)
Fields
- message string -
- errors InlineResponse400Errors - Map that sums up all received values that seemed incorrect
journey.io: InlineResponse400Errors![](/images/permalink.svg)
Map that sums up all received values that seemed incorrect
Fields
- fields record {}? - All input fields that seemed incorrect
- parameters InlineResponse400ErrorsParameters? - All query-, header- and path- parameters that seemed incorrect
journey.io: InlineResponse400ErrorsParameters![](/images/permalink.svg)
All query-, header- and path- parameters that seemed incorrect
Fields
- query record {}? -
- header record {}? -
- path record {}? -
journey.io: InlineResponse401![](/images/permalink.svg)
Fields
- meta InlineResponse201Meta -
- message string -
journey.io: LinkBody![](/images/permalink.svg)
Link web activity to user
Fields
- deviceId string -
- identification LinkIdentification - User identification requires a userId, email or both
journey.io: LinkIdentification![](/images/permalink.svg)
User identification requires a userId, email or both
Fields
- email string? - Email address of the user
- userId string? - Unique identifier for the user in your database
journey.io: UsersUpsertBody![](/images/permalink.svg)
Update properties of a user
Fields
- identification LinkIdentification - User identification requires a userId, email or both
- properties record {}? - The properties being set, possible values are strings, booleans, numbers and datetimes (ISO 8601)
Import
import ballerinax/journey.io;
Metadata
Released date: over 1 year ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Business Intelligence/Analytics
Cost/Freemium
Contributors
Dependencies