본문으로 건너뛰기
API docs by Redocly

mAsh API (2.0.1)

인증 토큰

인증 토큰 발급

사용자의 이메일과 비밀번호를 입력받아 인증을 거치고, 추후 인증에 사용될 인증 토큰과 새로고침 토큰을 반환합니다.

Request Body schema: application/json
email
required
string (이메일) non-empty

매쉬 사용자 이메일

password
required
string (비밀번호) non-empty

매쉬 사용자 비밀번호

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "access": "string",
  • "refresh": "string"
}

인증 토큰 새로 고침

새로고침 토큰을 입력받아 새로운 인증 토큰을 발급합니다.

Request Body schema: application/json
refresh
required
string (새로고침 토큰) non-empty

인증 토큰을 다시 얻기 위한 새로고침 토큰

Responses

Request samples

Content type
application/json
{
  • "refresh": "string"
}

Response samples

Content type
application/json
{
  • "access": "string"
}

인증 토큰 유효성 검사

토큰을 전달하여 해당 토큰이 유효한지 확인합니다. 토큰이 유효한 경우 빈 응답결과({})를 반환합니다.

Request Body schema: application/json
token
required
string (인증 토큰) non-empty

확인 대상 인증 토큰

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{ }

메타 데이터

매장 목록

query Parameters
search
string (이름 검색)
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

구역 목록

query Parameters
search
string (이름 검색)
page
integer (페이지 조회)
page_size
integer (페이지 크기)
include_category
boolean (결과값에 카테고리 칼럼 포함 여부)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

입/퇴장(라인) 목록

query Parameters
search
string (이름 검색)
page
integer (페이지 조회)
page_size
integer (페이지 크기)
include_category
boolean (결과값에 카테고리 칼럼 포함 여부)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

무방향 라인 목록

query Parameters
search
string (이름 검색)
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

이벤트소스그룹 목록

query Parameters
search
string (이름 검색)
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

이벤트소스그룹-라인 관계 목록

query Parameters
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

이벤트소스그룹-구역 관계 목록

query Parameters
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

데이터 업데이트 상태 목록

최근 30일 동안 매장별 방문객 데이터의 업데이트 상태 정보를 조회합니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

데이터 업데이트 최종 상태

어제부터 오늘까지, 모든 매장을 기준으로 방문객 데이터의 업데이트 상태 정보를 조회합니다.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

(이전 버전) 매장 목록 Deprecated

query Parameters
page
integer (페이지 조회)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

기본 통계 이벤트

매장 방문

query Parameters
place_id
string <uuid> (매장 아이디)
start_date
string <YYYY-mm-dd> (시작 일자)
end_date
string <YYYY-mm-dd> (마지막 일자)
0: 9세 이하 (integer) or 1: 10대 (integer) or 2: 20대 (integer) or 3: 30대 (integer) or 4: 40대 (integer) or 5: 50대 (integer) or 6: 60대 이상 (integer) (연령대)
0: 남성 (integer) or 1: 여성 (integer) (성별)
start_time
string <HH:MM> (시작 시각)
end_time
string <HH:MM> (마지막 시각)
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "is_all_data_available": true,
  • "missing_data": {
    },
  • "results": [
    ]
}

입/퇴장(라인) 방문

query Parameters
line_id
any
start_date
string <YYYY-mm-dd> (시작 일자)
end_date
string <YYYY-mm-dd> (마지막 일자)
0: 9세 이하 (integer) or 1: 10대 (integer) or 2: 20대 (integer) or 3: 30대 (integer) or 4: 40대 (integer) or 5: 50대 (integer) or 6: 60대 이상 (integer) (연령대)
0: 남성 (integer) or 1: 여성 (integer) (성별)
start_time
string <HH:MM> (시작 시각)
end_time
string <HH:MM> (마지막 시각)
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

구역 체류

query Parameters
zone_id
any
start_date
string <YYYY-mm-dd> (시작 일자)
end_date
string <YYYY-mm-dd> (마지막 일자)
0: 9세 이하 (integer) or 1: 10대 (integer) or 2: 20대 (integer) or 3: 30대 (integer) or 4: 40대 (integer) or 5: 50대 (integer) or 6: 60대 이상 (integer) (연령대)
0: 남성 (integer) or 1: 여성 (integer) (성별)
start_time
string <HH:MM> (시작 시각)
end_time
string <HH:MM> (마지막 시각)
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

(이전 버전) 입/퇴장 방문 Deprecated

query Parameters
place
string <uuid> (매장 아이디)
start_date
string <YYYY-mm-dd> (시작 일자)
end_date
string <YYYY-mm-dd> (마지막 일자)
0: 9세 이하 (integer) or 1: 10대 (integer) or 2: 20대 (integer) or 3: 30대 (integer) or 4: 40대 (integer) or 5: 50대 (integer) or 6: 60대 이상 (integer) (연령대)
0: 남성 (integer) or 1: 여성 (integer) (성별)
start_time
string <HH:MM> (시작 시각)
end_time
string <HH:MM> (마지막 시각)
page
integer (페이지 조회)

Responses

Response samples

Content type
application/json
{}

방문객 행동 이벤트

매장 방문객 행동

query Parameters
start_date
string <YYYY-mm-dd> (시작 일자)
end_date
string <YYYY-mm-dd> (마지막 일자)
0: 9세 이하 (integer) or 1: 10대 (integer) or 2: 20대 (integer) or 3: 30대 (integer) or 4: 40대 (integer) or 5: 50대 (integer) or 6: 60대 이상 (integer) (연령대)
0: 남성 (integer) or 1: 여성 (integer) (성별)
start_time
string <HH:MM> (시작 시각)
end_time
string <HH:MM> (마지막 시각)
zone_ids
Array of strings <uuid> (구역 아이디 배열)
line_ids
Array of strings <uuid> (라인 아이디 배열)
page
integer (페이지 조회)
page_size
integer (페이지 크기)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

대시보드

대시보드 데이터 조회

path Parameters
dashboard_uid
required
string

데이터를 불러올 대시보드 아이디입니다.

[대시보드 아이디 확인 방법]

  1. 매쉬보드에 로그인합니다.
  2. 대시보드 목록에서 데이터를 불러올 대시보드를 클릭합니다.
  3. 브라우저 상단 URL을 보시면, /dashboards/** 규칙으로 대시보드 아이디가 경로에 포함되어 있습니다.
  • 예: /dashboards/ 9e59e9a9-273c-4f62-82b8-61e3b24742b7
query Parameters
start_date
required
string <YYYY-mm-dd> (시작 일자)
end_date
required
string <YYYY-mm-dd> (마지막 일자)
output_type
required
string
Enum: "JSON" "RAW_JSON"

결과 데이터 형식. RAW_JSON은 매장과 구역 ID가 포함된 원본 데이터, JSON은 매장과 구역 이름이 포매팅된 데이터입니다.

Responses

Response samples

Content type
application/json
{
  • "dashboard_uid": "string",
  • "dashboard_name": "string",
  • "is_all_data_available": true,
  • "missing_data": {
    },
  • "owner": {
    },
  • "board_uid": "string",
  • "board_name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "✅ widgets": {
    }
}