how to use next link

[JohnSColeman]

When consuming customer reviews the response may contain a link to the next set of reviews. There does not seem to be a mechanism available on the API to handle this scenario.

[isaced]

It seems that for paginated APIs, it is necessary to parse links.next in the Response to continue initiating the next page request.

{
 ...
  links: {
    self: "https://api.appstoreconnect.apple.com/v1/apps/xxxxx/customerReviews",
    first: undefined,
    next: "https://api.appstoreconnect.apple.com/v1/apps/xxxx/customerReviews?cursor=Ma.AMl1C-1",
  },
  meta: {
    paging: {
      total: 345,
      limit: 50,
    },
  }
}

It seems that for paginated APIs, it is necessary to parse links.next in Response to continue to initiate the next page request.

I plan to add a method similar to request(url: string) in Client for this purpose. If you have a better idea, please let me know.

[isaced]

v1.3.0 has been released, adding a new client.request() method to send other requests. here is an example of requesting reviews pagination, hope it can help you.

import { AppStoreConnectAPI } from "appstore-connect-sdk";
import { AppsApi, CustomerReviewsResponse } from "appstore-connect-sdk/openapi";

const client = new AppStoreConnectAPI({
    issuerId: process.env.ISSUER_ID,
    privateKeyId: process.env.PRIVATE_KEY_ID,
    privateKey: process.env.PRIVATE_KEY,
});
const api = await client.create(AppsApi);

// fetch apps
const res = await api.appsGetCollection();
console.log('Fetch apps count:', res.data.length);

const appId = res.data[1].id;

// fetch reviews
const reviews = await api.appsCustomerReviewsGetToManyRelated({ id: appId });
console.log('Fetch reviews links:', reviews.links);

// fetch next page reviews
if (reviews.links.next) {
    const nextPageRes = await client.request({
        url: reviews.links.next
    })
    const nextPageReviews = (await nextPageRes.json()) as CustomerReviewsResponse
    console.log('Fetch next page reviews:', nextPageReviews.meta?.paging.total);
}

https://github.com/isaced/appstore-connect-sdk/blob/main/test/reviews.test.ts