Skip to main content
생성한 트래킹 링크 목록을 조회합니다.

Try API Request

GET

Request


Headers

string
API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.
string
리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.
string
API 요청에 사용하는 키값입니다. 키값 생성 및 조회 방법을 확인하여 획득할 수 있습니다.

Query Params

string
필수
생성한 트래킹 링크 목록을 조회할 기준 시작일.
string
필수
생성한 트래킹 링크 목록을 조회할 기준 종료일.
number
다음 트래킹 링크 데이터를 이어서 조회하기 위한 기준 ID.
number
가져올 item의 갯수. (최대 1000)
string
검색 키워드.
string
채널 명 필터.
enum
정렬 기준 (기본값: createdAt)
enum
정렬 타입. (기본값: ASC)

Response


200

totalCount
  • 타입: number
  • 설명: 응답에 포함된 트래킹 링크의 개수를 나타냅니다. 요청 시 지정한 size 값보다 클 수 없으며, 요청에 size를 지정하지 않은 경우 최대 1,000까지 반환됩니다. 조회 기간 동안 생성된 트래킹 링크가 없는 경우 0이 반환됩니다.
hasNext
  • 타입: boolean
  • 설명: from, to 기간 내에 추가로 조회할 수 있는 트래킹 링크가 존재하는지를 나타냅니다. true는 추가 데이터 있음, false는 더 이상 조회할 데이터 없음을 의미합니다. 일반적으로 nextCursor와 함께 사용됩니다.
nextCursor
  • 타입: number (nullable)
  • 설명: 다음 트래킹 링크를 요청할 때 사용되는 값입니다.
    • 예를 들어, 앱에서 생성된 1,001번째 트래킹 링크 ID가 20002342라면, 첫 요청으로 트래킹 링크 1,000개를 받은 후 응답에 “next_cursor”: “20002342”가 포함되어 반환됩니다. 이후 요청에서 이 값을 next_cursor 파라미터로 전달하면, 1,001번째부터 2,000번째까지의 트래킹 링크를 조회할 수 있습니다.
    • 단, ID는 Airbridge에서 생성되는 전체 트래킹 링크를 기준으로 부여되기 때문에, 해당 앱에서 생성한 순서와 일치하지 않거나 연속적이지 않을 수 있습니다. 더 이상 조회할 데이터가 없는 경우 null이 반환됩니다.

400

입력한 필드가 오류가 있거나 형태가 올바르지 않습니다.