ShortUrlEntity

A short link.

type ShortUrlEntity {
  clickCount: Int!
  createdAt: DateTime!
  createdBy: String
  customAlias: String
  description: String
  expiresAt: DateTime
  id: String!
  isActive: Boolean!
  lastClickedAt: DateTime
  metadata: JSON
  organizationId: String
  originalUrl: String!
  shortCode: String!
  shortUrl: String!
  tags: [String!]!
  title: String
  updatedAt: DateTime!
}

Fields

ShortUrlEntity.clickCount ● Int! non-null scalar

How many times the link was clicked.

ShortUrlEntity.createdAt ● DateTime! non-null scalar

When the record was created.

ShortUrlEntity.createdBy ● String scalar

The ID of the user who created the link.

ShortUrlEntity.customAlias ● String scalar

The custom short code, if one was chosen.

ShortUrlEntity.description ● String scalar

What the link is for.

ShortUrlEntity.expiresAt ● DateTime scalar

When the link stops working.

ShortUrlEntity.id ● String! non-null scalar

The unique ID of this record.

ShortUrlEntity.isActive ● Boolean! non-null scalar

Whether the record is active.

ShortUrlEntity.lastClickedAt ● DateTime scalar

When the link was last clicked.

ShortUrlEntity.metadata ● JSON scalar

Additional data attached to the record, as JSON.

ShortUrlEntity.organizationId ● String scalar

The ID of the organization the record belongs to.

ShortUrlEntity.originalUrl ● String! non-null scalar

The address the short link leads to.

ShortUrlEntity.shortCode ● String! non-null scalar

The short code.

ShortUrlEntity.shortUrl ● String! non-null scalar

The full short address.

ShortUrlEntity.tags ● [String!]! non-null scalar

Tags on the link.

ShortUrlEntity.title ● String scalar

A title for the link.

ShortUrlEntity.updatedAt ● DateTime! non-null scalar

When the record was last changed.

Returned By

createShortUrl mutation ● shortUrl query ● shortUrls query ● updateShortUrl mutation