Class Tag

constructor

• new Tag(tag, shClient): Tag

• Parameters

  • tag: string | statsTagJson
  • shClient: Shlink

  Returns Tag

Optional ReadonlyshortUrlsCount

tag

Optional ReadonlyvisitsSummary

delete

• delete(): Promise<void>

• Delete this tag

  Returns Promise<void>

getVisits

• getVisits(startDate?, endDate?, page?, itemsPerPage?, excludeBots?): Promise<{
      maxPages: number;
      page: number;
      visits: Visit[];
  }>

• Get the visits from this tag

  Parameters

  • OptionalstartDate: Date
  • OptionalendDate: Date
  • Optionalpage: number
  • OptionalitemsPerPage: number
  • OptionalexcludeBots: boolean

  Returns Promise<{
      maxPages: number;
      page: number;
      visits: Visit[];
  }>

rename

• rename(newName): Promise<void>

• Rename this tag

  Parameters

  • newName: string

  Returns Promise<void>