umami-software / api-client Goto Github PK

From the compiled types it's impossible to use api-client like the doc said.

No client exported from the lib

I have to use getClient

const client = getClient();

to get the client instance (not a problem actually but the doc should be consistent with the real usage)

Hi,
thank you for your work.
I think the types on getEventDataEvents should get Umami.WebsiteEventData[]
instead of Umami.WebsiteEventData to return a right type?

getEventDataEvents(websiteId: string, params: { startAt: number; endAt: number; event?: string; }): Promise<ApiResponse<Umami.WebsiteEventData[]>>;

So apparently since [email protected] they're using undici instead of node-fetch and that causes this error.

There're plenty of GH issues related and it seems that it's not solved in next 14.0.3.
vercel/next.js#44062
vercel/next.js#54961

I don't know how relevant this issue can be but posting instead someone else’s struggling with client functions like createWebsite.

In the doc https://umami.is/docs/api-client the userId var is called UMAMI_API_CLIENT_USER_ID when it's UMAMI_API_USER_ID in the code

Linked with #10

The API endpoint in the docs should not have a slash at the end.

UMAMI_API_CLIENT_ENDPOINT=https://api.umami.is/v1/

should be

UMAMI_API_CLIENT_ENDPOINT=https://api.umami.is/v1

It feels like this API client is outdated?

It looks like the extra params on the getWebsiteStats and getWebsiteMetrics are not marked as optional.

So in this function

const { data } = await client().getWebsiteStats(websiteId, {
    startAt: 1685566800000,
    endAt: 1686916052440,
    url: '/about'
  });

You get this error

Argument of type '{ startAt: number; endAt: number; url: string; }' is not assignable to parameter of type '{ startAt: number; endAt: number; url: string; referrer: string; title: string; query: string; event: string; os: string; browser: string; device: string; country: string; region: string; city: string; }'.

Making a call to this endpoint getWebsiteStats returns error code 500

const { data } = await client().getWebsiteStats(websiteId, {
    startAt: 1685566800000,
    endAt: 1686916052440,
  });

The same endpoint directly via the REST API works just fine though:

curl --request GET \
  --url https://api.umami.is/v1/websites/<website id>/stats \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'x-umami-api-key: <api key>' \
  --data startAt=1685566800000 \
  --data endAt=1686916052440

I messaged on discord as well, so you can DM me there if you need my exact website ID for debugging!