Links

Create a short link

A short address on Rizamo's link host that sends people on to url and counts each click, by day and country. Nothing about the person who clicks is kept: no IP address, cookie or device. Link previews (Instagram, Facebook, WhatsApp, Slack, X and others) and bots are not counted. Without profileId, the link is yours (the person, key or agent that made it) and people limited to some profiles do not see it. A team makes up to 1,000 links in 24 hours, and only once it has a connected account or a paid plan (403 until then).

post/links

Request

  • Base URL
    https://api.rizamo.com/v1
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

1 to 255 printable characters, new for each request (a UUID); the body up to 1 MB. For 24 hours a repeat with the same key, path and body gets the first answer, with Idempotent-Replayed: true, instead of running again; 5xx, 409 and 429 answers are not kept. Errors, Retries, has the rest.

Request body

urlstring required

Where the link sends people: a public http or https address, up to 2,048 characters, without line breaks. It is kept as the URL standard writes it (url in the answer: the host in ASCII, the path encoded). Rizamo's own short links are refused, so a link never points at another.

profileIdstring

A profile you reach, which the link belongs to.

expiresAtstring date-time

When it stops working, in the future. Left out, it never expires.

Response

OK

idstring required
codestring required
shortUrlstring required

The link to share. It sends people on to url and counts the click.

urlstring required

Where it sends people.

profileIdstring nullable required

The profile it belongs to. Null: it is its creator's (the person, key or agent that made it).

clicksinteger required

Clicks so far. Link previews and bots are not counted; one person clicking twice counts twice.

expiresAtstring date-time nullable required

From then on the link answers 404. Null: it never expires.

disabledAtstring date-time nullable required

When Rizamo disabled it for breaking the Acceptable Use Policy: it answers 404 from then on, whatever changes. Null for every other link.

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.