Item

An item in Tycka can be anything that can have reviews collected on it. Examples could be, but not limited to products or services (shipping, website experience).

To get items into Tycka, please use the import REST API.

Built in fields:

Name	Type
ItemId	string
ImageUrls	string array
Name	string

Besides the built in fields, you can have custom fields set up on the items.

Author

Author is data about the person behind a review. When reviews are published, the current author information is published together with the review.

Fields:

Name	Type
AuthorId	string
Name	string
Email	string

Review

While authors and items are usually maintained outside of Tycka and synced into the system. Reviews are managed within Tycka and Tycka is the true source of truth, other systems are meant to consume the Tycka review data. Reviews holds the actual review data and is linked to an item and an author.

Built in fields:

Name	Type	Remarks
ReviewId	string
ItemId	string
TransactionId	string	Optional
Language	string	Optional but recommended
CreatedAt	UTC datetime string
IsPublished	boolean
PublishedAt	UTC datetime string	Optional
DeletedAt	UTC datetime string	Optional
Response	object	Optional

Datetime strings are simplified ISO 8601, we only want the date and time part of it

Response object fields:

Name	Type
AgentId	string
Content	string

Besides the built in fields, you can have custom fields set up on the reviews.

Transaction

A transaction serves multiple purposes in tycka. It is the source where we base the post purchase event on, which you can hook up to for example an email. Its also the source that we use to verify a review against, check if the item reviewed was actually part of a transaction. When the form loads, if the transaction id and secret is made available, the client will be able to fetch the custom data that has been added to the transaction, this data opaque to tycka and only intended to be used on the client side to prefill in and customize the review collection experience.